Payment payload details

Payment details for making a purchase

In order to complete a purchase, some form of payment is required. Below we will outline what fields are required for each payment included in an order.

Click the link for more information on Making a reservation purchase

In person providers:

Cash

Required fields: "method", "amount", "currencyCode", "description"

{
    "amount": 61,
    "method": "cash",
    "currencyCode": "USD", 
    "displayName": "Cash", 
    "provider": "inperson",
    "paymentMethodId": "c426da53-7ba7-4add-8538-5d156c230155",
    "description": "Order N° 5e0a5ace033c1d03214ce0a5",       
    "amountDisplay": "61.00",                                 
    "acceptedCurrencyAmount": 61,                             
    "acceptedCurrencyAmountDisplay": "61.00",                 
    "acceptedCurrency": null,                                 
    "currencyAdjustment": 0
}


Debit

Required fields: "method", "amount", "authorization", "currencyCode", "description"

{
    "amount": 61,
    "method": "debit",
    "currencyCode": "USD", 
    "displayName": "Debit", 
    "authorization": "1234",
    "provider": "inperson",
    "paymentMethodId": "c426da53-7ba7-4add-8538-5d156c230155",
    "description": "Order N° 5e0a5ace033c1d03214ce0a5",       
    "amountDisplay": "61.00",                                 
    "acceptedCurrencyAmount": 61,                             
    "acceptedCurrencyAmountDisplay": "61.00",                 
    "acceptedCurrency": null,                                 
    "currencyAdjustment": 0
}


Credit

Required fields: "method", "amount", "authorization", "cardType", "currencyCode", "description"

{
    "amount": 61,
    "method": "credit",
    "currencyCode": "USD", 
    "displayName": "Credit",
    "cardType": "visa", 
    "authorization": "1234",
    "provider": "inperson",
    "paymentMethodId": "c426da53-7ba7-4add-8538-5d156c230155",
    "description": "Order N° 5e0a5ace033c1d03214ce0a5",       
    "amountDisplay": "61.00",                                 
    "acceptedCurrencyAmount": 61,                             
    "acceptedCurrencyAmountDisplay": "61.00",                 
    "acceptedCurrency": null,                                 
    "currencyAdjustment": 0
}


Gift Certificate

Required fields: "method", "authCode", "amount", "description"

{
    "amount": 1,
    "method": "gift_certificate",
    "currencyCode": "USD",
    "displayName": "Gift certificate",
    "balance": "0.00",
    "authCode": "GC-5e0b78453eb3f516c1486f0e",
    "provider": "inperson",
    "paymentMethodId": "b294d811-fd8c-416a-a3c1-184159ed108f",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "1.00",
    "acceptedCurrencyAmount": 1,
    "acceptedCurrencyAmountDisplay": "1.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Voucher

Required fields: "method", "voucher", "amount", "firstName", "description"

{
    "amount": 20,
    "method": "voucher",
    "currencyCode": "USD",
    "displayName": "Voucher",
    "firstName": { "firstName": "Jon", "lastName": "Snow" },
    "voucher": "VC-24ZMRWRM",
    "provider": "inperson",
    "paymentMethodId": "75767017-c5ed-44fb-a2a6-2949c29ba3ee",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "20.00",
    "acceptedCurrencyAmount": 20,
    "acceptedCurrencyAmountDisplay": "20.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Custom inperson payment method

Required fields: "method", "amount", "description", "currencyCode"

{
    "amount": 61,
    "method": "custom",
    "currencyCode": "USD",
    "displayName": "custom",
    "provider": "inperson",
    "paymentMethodId": "11188068-690d-4c90-946f-b0ba40e12c5b",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Employee pass

Required fields: "method", "amount", "description", "currencyCode", "externalId"

{
    "amount": 33.31,
    "method": "employee_pass",
    "currencyCode": "CAD",
    "displayName": "Employee pass",
    "externalId": "3474",
    "provider": "inperson",
    "paymentMethodId": "a8b1befd-d61a-426a-b5d5-cea0d3b245ea",
    "description": "Order N° 5e0bb723981bd52197642bb5",
    "amountDisplay": "33.31",
    "acceptedCurrencyAmount": 33.31,
    "acceptedCurrencyAmountDisplay": "33.31",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Monthly Pass

Required fields: "method", "authorization", "amount", "description", "currencyCode"

{
    "method": "monthly_pass",
    "amount": 10.00,
    "authorization": "AuthCode",
    "currencyCode": "CAD",
    "displayName": "Monthly pass",
    "provider": "inperson",
    "paymentMethodId": "a8b1befd-d61a-426a-b5d5-cea0d3b245ea",
    "description": "Order N° 5e0bb723981bd52197642bb5",
    "amountDisplay": "10.00",
    "acceptedCurrencyAmount": 10.00,
    "acceptedCurrencyAmountDisplay": "10.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0          
}


Pay on Account

Required fields: "method", "authorization", "amount", "externalId", "currencyCode", "description"

{
    "amount": 61,
    "method": "pay_on_account",
    "currencyCode": "USD",
    "displayName": "Pay on account",
    "externalId": "22693",
    "authorization": "123",
    "provider": "inperson",
    "paymentMethodId": "5e1f37a9-e3ae-4040-99d4-026faa41f666",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Online credit providers:

Authorize.Net

Required fields: "method", "ccnumber", "expiryMonth", "expiryYear", "amount", "description", "currencyCode"

{
    "amount": 61,
    "method": "online_credit",
    "currencyCode": "USD",
    "displayName": "Credit card",
    "ccnumber": "4111111111111111",
    "sec": "123",
    "expiryMonth": 2,
    "expiryYear": 2020,
    "firstName": "Jon",
    "lastName": "Snow",
    "card": "visa",
    "street": "The Palace 123",
    "city": "Kingslanding",
    "country": { "key": "GB", "value": "United kingdom", "provinces": [] },
    "state": { "key": "South" },
    "zipCode": "123",
    "provider": "authorizeNet",
    "paymentMethodId": "39c69700-dca2-4f8a-bf54-3474a7759c81",
    "description": "Order N° 5e0b6a59ca6fb858b4075c4a",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Authorize.Net using a saved credit card

Required fields: "method", "customerId", "paymentProfileId", "amount", "description", "currencyCode", "useProfile": true

{
    "useProfile": true,
    "amount": 61,
    "method": "online_credit",
    "currencyCode": "USD",
    "displayName": "Credit card",
    "customerId": "5e0b6a59ca6fb858b4075c4b",
    "paymentProfileId": "39c69700-dca2-4f8a-bf54-3474a7759c99",
    "firstName": "Jon",
    "lastName": "Snow",
    "card": "visa",
    "street": "The Palace 123",
    "city": "Kingslanding",
    "country": { "key": "GB", "value": "United kingdom", "provinces": [] },
    "state": { "key": "South" },
    "zipCode": "123",
    "provider": "authorizeNet",
    "paymentMethodId": "39c69700-dca2-4f8a-bf54-3474a7759c81",
    "description": "Order N° 5e0b6a59ca6fb858b4075c4a",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Paypal

Required fields: "method", "card", "ccnumber", "expiryMonth", "expiryYear", "amount", "description"

{
    "amount": 61,
    "method": "online_credit",
    "currencyCode": "USD",
    "displayName": "Credit card",
    "ccnumber": "4111111111111111",
    "sec": "123",
    "expiryMonth": 2,
    "expiryYear": 2020,
    "firstName": "Jon",
    "lastName": "Snow",
    "card": "visa",
    "street": "The Palace",
    "city": "Kingslanding",
    "country": { "key": "GB", "value": "United kingdom", "provinces": [] },
    "state": { "key": "South" },
    "zipCode": "123",
    "provider": "paypal",
    "paymentMethodId": "e9fcc1ac-4235-4ccd-888f-04bfe13b43cc",
    "description": "Order N° 5e0b66c0ca6fb858b4075c47",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Stripe

Required fields: "method", "ccnumber", "expiryMonth", "expiryYear", "amount", "description", "currencyCode"

Stripe suggest to always ask for the address information if possible and it needs to match the billing information for the CC used in that case.

{
    "amount": 11.22,
    "method": "online_credit",
    "displayName": "Credit card",
    "currencyCode": "GBP", //It is the currency ISO code
    "ccnumber": "4111111111111111",
    "ccv": "123", //It is the card security code
    "description": "Order N° 5c4f1b3fe3f8a33d531a8a62",
    "expiryMonth": 1,
    "expiryYear": 2027,
    "firstName": "Sherlock", // As shown in the CC
    "lastName": "Holmes",  // As shown in the CC
    "street": "221b Baker Street",
    "city": "London",
    "country": {
    "value": "England"
    },
    "state": "London",
    "zipCode": "NW1 6XE",
    "provider": "stripe",
    "paymentMethodId": "c7fe2c51-178b-4ae3-bbe8-0c606f3e0117",
    "amountDisplay": "11.22",
    "acceptedCurrencyAmount": 11.22,
    "acceptedCurrencyAmountDisplay": "11.22",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Stripe using a saved credit card

Required fields: "method", "customerId", "paymentProfileId", "amount", "description", "currencyCode", "useProfile": true

{
    "useProfile": true,
    "amount": 11.22,
    "method": "online_credit",
    "displayName": "Credit card",
    "currencyCode": "GBP", //It is the currency ISO code
    "customerId": "5e0b6a59ca6fb858b4075c4b",
    "paymentProfileId": "39c69700-dca2-4f8a-bf54-3474a7759c99",
    "description": "Order N° 5c4f1b3fe3f8a33d531a8a62",
    "firstName": "Sherlock", // As shown in the CC
    "lastName": "Holmes",  // As shown in the CC
    "street": "221b Baker Street",
    "city": "London",
    "country": {
    "value": "England"
    },
    "state": "London",
    "zipCode": "NW1 6XE",
    "provider": "stripe",
    "paymentMethodId": "c7fe2c51-178b-4ae3-bbe8-0c606f3e0117",
    "amountDisplay": "11.22",
    "acceptedCurrencyAmount": 11.22,
    "acceptedCurrencyAmountDisplay": "11.22",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Moneris

Required fields: "method", "ccnumber", "expiryMonth", "expiryYear", "amount", "description"

{
    "amount": 61,
    "method": "online_credit",
    "currencyCode": "USD",
    "displayName": "Credit card",
    "ccnumber": "4111111111111111",
    "sec": "123",
    "expiryMonth": 2,
    "expiryYear": 2020,
    "firstName": "Jon",
    "lastName": "Snow",
    "card": "visa",
    "street": "The Palace 123",
    "city": "Kingslanding",
    "country": { "key": "GB", "value": "United kingdom", "provinces": [] },
    "state": {"key": "South" },
    "zipCode": "123",
    "provider": "moneris_ca",
    "paymentMethodId": "504eb86f-020c-4336-baab-280141f64317",
    "description": "Order N° 5e0b6bbeca6fb858b4075c4d",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Reference payments providers:

Pay me later

Required fields: "method", "amount", "paymentMethodId", "externalType", "description", "currencyCode", "amountDisplay", "acceptedCurrencyAmount", "acceptedCurrencyAmountDisplay", "currencyAdjustment"

{
    "amount": 61,
    "method": "pay_me_later",
    "currencyCode": "USD",
    "displayName": "pay me later",
    "provider": "referencedPayments",
    "externalType": "pay_me_later_external_name",
    "paymentMethodId": "8ba68191-1634-4938-8744-30d622e8491a",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Pay near me

Required fields: "method", "amount", "paymentMethodId", "externalType", "description", "currencyCode", "amountDisplay", "acceptedCurrencyAmount", "acceptedCurrencyAmountDisplay", "currencyAdjustment"

{
    "amount": 61,
    "method": "pay_near_me",
    "currencyCode": "USD",
    "displayName": "pay near me",
    "provider": "referencedPayments",
    "externalType": "pay_near_me_external_name",
    "paymentMethodId": "8ba68191-1634-4938-8744-30d622e8491a",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


IVR

Required fields: "method", "amount", "paymentMethodId", "externalType", "description", "currencyCode", "amountDisplay", "acceptedCurrencyAmount", "acceptedCurrencyAmountDisplay", "currencyAdjustment"

{
    "amount": 61,
    "method": "ivr",
    "currencyCode": "USD",
    "displayName": "ivr",
    "provider": "referencedPayments",
    "externalType": "ivr_external_name",
    "paymentMethodId": "8ba68191-1634-4938-8744-30d622e8491a",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


Pinpad

Required fields: "method", "amount", "paymentMethodId", "externalType", "description", "currencyCode", "amountDisplay", "acceptedCurrencyAmount", "acceptedCurrencyAmountDisplay", "currencyAdjustment", "pinpadNumber"

{
    "amount": 61,
    "method": "pinpad",
    "currencyCode": "USD",
    "pinpadNumber": "1239",
    "displayName": "pinpad",
    "provider": "referencedPayments",
    "externalType": "pinpad_external_name",
    "paymentMethodId": "8ba68191-1634-4938-8744-30d622e8491a",
    "description": "Order N° 5e0b71eb3eb3f516c1486f07",
    "amountDisplay": "61.00",
    "acceptedCurrencyAmount": 61,
    "acceptedCurrencyAmountDisplay": "61.00",
    "acceptedCurrency": null,
    "currencyAdjustment": 0
}


In case of multi-currency:

In case of having the following field as in the examples above:

{
    "acceptedCurrency": null
}


The following data is needed in acceptedCurrency:

{
    "acceptedCurrency":
     { "isocode": "USD",
       "symbol": "$",
       "buy": 0.04,
       "sell": 0.05,
       "channels": [ 
          "backoffice",                                         
          "agency-backoffice",                                                                                
          "websales",                                                                                         
          "agency-websales" 
          ] 
      },
}


For example, for Credit with multi-currency:

{
    "amount": 250,
    "method": "credit",
    "currencyCode": "MXN",
    "displayName": "In person credit card",
    "cardType": "visa",
    "authorization": "123",
    "provider": "inperson",
    "paymentMethodId": "c4b39700-ee6a-40af-8215-ba4959be6d9f",
    "description": "Order N° 5e0b9c4fe8b00b6e51320dd9",
    "amountDisplay": "250.00",
    "acceptedCurrencyAmount": 10,
    "acceptedCurrencyAmountDisplay": "10.00",
    "acceptedCurrency":
     { "isocode": "USD",
       "symbol": "$",
       "buy": 0.04,
       "sell": 0.05,
       "channels": [ 
          "backoffice",                                         
          "agency-backoffice",                                                                                
          "websales",                                                                                         
          "agency-websales" 
        ] 
      },
    "currencyAdjustment": 0 }  
}


The particular case for cash multi-currency:

In addition to the data in "acceptedCurrency" it is needed "exchangeDetails"

{
    "amount": 145,                                                                  
    "method": "cash", 
    "currencyCode": "MXN",                                                        
    "displayName": "Cash",                                                        
    "exchangeDetails": { 
      "exchangeCurrency": { 
        "isocode": "MXN",                                
        "symbol": "$",                                                                                        
        "enabled": true,                                                                                      
        "exchangeRates": [ 
          { 
              "buy": 0.04,                                                                                        
              "sell": 0.05,                                                                                       
              "updatedAt": {
                "value": "2020-01-01",
                "offset": 0 
              },                                                                           
              "updatedBy": "5db9093325dfd417d86c50f1" 
          }
        ]
        },                                              
       "acceptedCurrencyAmount": 580000,                                          
       "acceptedCurrencyAmountReceived": 580000,                                  
       "acceptedCurrencyAmountReturned": 0,                                       
       "exchangeCurrencyAmount": 14500000,                                        
       "exchangeCurrencyAmountReceived": 14500000,                                
       "exchangeCurrencyAmountReturned": 0 
    },                                     
    "provider": "inperson",                                                         
    "paymentMethodId": "faf538e1-d0dd-4309-9fb9-438e849511b0",                    
    "description": "Order N° 5e0a4c9b7a109320c72e1e53",                           
    "amountDisplay": "145.00",                                                    
    "acceptedCurrencyAmount": 5.8,                                                
    "acceptedCurrencyAmountDisplay": "5.80",                                      
    "acceptedCurrency": {  
      "isocode": "USD",                                                          
      "symbol": "$",                                                             
      "buy": 0.04,                                                               
      "sell": 0.05,                                                              
      "channels": [ 
        "backoffice",                                         
        "agency-backoffice",                                                                                
        "websales",                                                                                         
        "agency-websales" 
      ]  
    },                                                     
    "currencyAdjustment": 0 
}