Fluent Commerce Logo
Docs
Sign In

paymentTransaction graphQL query and mutation

Essential knowledge

Author:

Fluent Commerce staff

Changed on:

23 Nov 2023

Overview

The

`paymentTransaction`
is an entity that is required as part of the payment process. 

Key points

  • The page provides GQL example of how to use
    `paymentTransaction`
    :
    • Create
    • Update (not available)
    • Query

Create

1POST: {{fluentApiHost}}/graphql
2
3QUERY:
4
5
6
7mutation createPaymentTransaction ($input: CreatePaymentTransactionInput) {
8    createPaymentTransaction (input: $input) {
9        id
10        ref
11        type
12        status
13        authorizationKey
14        cardType
15        paymentMethod
16        createdOn
17        updatedOn
18    }
19}
20Variables:
21
22
23
24{
25  "input": {
26      "ref": "PT000002A",
27      "type": "PT_TYPE1",
28      "status": "ACTIVE",
29      "payment":{"ref":"PAYMENT000002"},
30      "amount": {
31        "amount": "654.11",
32        "scale": 1,
33        "unscaledValue": 1
34      },
35      "currency": {
36        "alphabeticCode": "AUD"
37      },
38      "authorizationKey": "1234567",
39      "cardType": "VISA",
40      "paymentMethod": "CARD",
41      "paymentServiceProvider": {
42        "ref": "PSP002:199"
43      },
44      "attributes": {
45        "name": "PaymentType",
46        "type": "STRING",
47        "value": "HELLO TYPE"
48      }
49  }
50}

Language: graphqlschema

Name: paymentTransaction create example

Description:

[Warning: empty required content area]

Update

This is not available.

Query

1POST: {{fluentApiHost}}/graphql
2
3Query:
4
5
6
7{
8    paymentTransaction(ref:"PT000002A"){
9                amount{ 
10                    amount
11                    scale
12                    unscaledValue
13                }
14                cardType
15                id
16                ref
17                status
18                authorizationKey
19                createdOn
20                currency{
21                    alphabeticCode
22                }
23                payment{
24                    id
25                }
26                paymentMethod
27                paymentServiceProvider{
28                    id
29                    ref
30                }
31                type
32
33
34
35            }
36}

Language: plain_text

Name: paymentTransaction query example

Description:

[Warning: empty required content area]
1POST: {{fluentApiHost}}/graphql
2
3Query:
4
5
6
7{
8    paymentTransactions{
9        edges{
10            node{
11                amount{ 
12                    amount
13                    scale
14                    unscaledValue
15                }
16                cardType
17                id
18                ref
19                status
20                authorizationKey
21                createdOn
22                currency{
23                    alphabeticCode
24                }
25                payment{
26                    id
27                }
28                paymentMethod
29                paymentServiceProvider{
30                    id
31                    ref
32                }
33                type
34            }
35        }
36    }
37}

Language: graphqlschema

Name: paymentTransactions query example

Description:

[Warning: empty required content area]


Fluent Commerce staff

Fluent Commerce staff

Copyright © 2024 Fluent Retail Pty Ltd (trading as Fluent Commerce). All rights reserved. No materials on this docs.fluentcommerce.com site may be used in any way and/or for any purpose without prior written authorisation from Fluent Commerce. Current customers and partners shall use these materials strictly in accordance with the terms and conditions of their written agreements with Fluent Commerce or its affiliates.

Fluent Logo