Create Realtime Payment

post

https://api.getpinch.com.au/test/payments/realtime

Take credit card payments with a realtime response.

Body Params

payerId

string

The Payer ID to use, if you're executing this payment against an existing payer.

fullName

string

Use Full Name, or First Name and Last Name

firstName

string

Use Full Name, or First Name and Last Name

lastName

string

Use Full Name, or First Name and Last Name

string

The email address of the payer

mobileNumber

string

A non-international Australian 10-digit mobile number

amount

int32

required

The payment amount in cents

applicationFee

int32

Optional additional fee (in cents) that goes to the parent merchant (Managed Merchants Only)

description

string

An optional description for the payment. Will be visible to the payer. Must be less than 1000 characters.

sourceId

string

Specify an existing payment source to use for this transaction. If empty, the default will be used. If you are creating a new source, use the creditCardToken field instead.

token

string

The credit card or bank account token created by the capture script. See the Guide for more info.

surcharge

array of strings

A list of source types to surcharge (Pass on the fees to the customer). eg. ['bank-account', 'credit-card']

surcharge

nonce

array of strings

Optional. A nonce is a one-time-use reference that represents a unique payment. Used to prevent double submissions of payments. If left empty all submissions will be treated as unique. Can be a string or array of strings. Each nonce must not exceed 250 characters and the length of all nonces must not exceed 4000 characters.

nonce

metadata

string

Free text field that you can use to store state against certain entities. Can be used for accounting integration, see Metadata

Responses

Language

Credentials

OAuth2

Request

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201

400400