Using Open Payments
An open payment is a single-step payment transaction that can be called directly from a merchant application via the secure payments API. An open payment transaction does not require a payment intent.
An open payment is a single-step payment transaction that can be called directly from a merchant application via the secure payments API. An open payment transaction does not require a payment intent. Scenarios where open payments can be used include:
- A PCI-compliant merchant submits a one-time payment along with the customer’s account details (RAW PAN) where the account information is not to be tokenized.
- A merchant schedules a series of recurring payments using a customer’s tokenized payment method.
Creating an Open Payment
An open payment is created by calling the POST Create Secure Payment Request method with a transaction type of OpenPayment. The merchant provides a unique paymentReference to identify the transaction. The channelType parameter indicates the method of payment.
Example: Open Payment request body (ACH)
"type": "OpenPayment",
"paymentReference": "PMT-543212345",
"transactionCode": "Web",
"channelType": "ACH",
"tenderInfo": {
"amount": "30",
"AccountHolderName": "John B Smith",
"routingNumber": "011000138",
"bankName": "null",
"accountNumber": "123456789",
"removeDiscounting": false,
"taxAmount": 0,
"accountType": "checking"
},
"billingcontact": {
"phone": "8003213388",
"name": {
"firstname": "Mayur",
"lastname": "Said"
},
"address": {
"addressLine1": "30",
"addressLine2": "Memorial Drive",
"city": "Avon ",
"state": "NY",
"country": 1,
"postalCode": "12345"
}
}
}
Open Payment with Tokenized Payment Method
When a tokenized payment method is used in an open payment transaction, the accountToken is passed in place of the customer’s account details. The channelType parameter must match the tokenized payment method. See Creating and Using Account Tokens to learn more about tokenization.
Example: Open Payment Request body (Tokenized payment method)
"type": "OpenPayment",
"paymentReference": "PMT-876541230",
"transactionCode": "Web",
"channelType": "ACH",
"tenderInfo": {
"amount": "15",
"accountToken": "8RWX1BNZWLQM3YGN"
},
"billingcontact": {
"phone": "8003213388",
"name": {
"firstname": "Mayur",
"lastname": "Said"
},
"address": {
"addressLine1": "30",
"addressLine2": "Memorial Drive",
"city": "Avon ",
"state": "NY",
"country": 1,
"postalCode": "12345"
}
}
}