GuidesAPI ReferencePinch Website
HomeGuidesAPI Reference
GuidesAPI ReferencePinch WebsitePinch PortalLog In
API Reference
Pinch Portal

Create or Update Payment

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

Create or Update a Scheduled Payment

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string

If you include an ID this endpoint will update, otherwise it create a new payment

string
required

The ID of the payer in pyr_XXXXXXXXXXXXXX format

int32
required

The payment amount in cents

date
required

The date to attempt the transaction

string

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

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
string

Optional. The ID of the payment Source you want to use. If omitted, the first valid source will be used.

surcharge
array of strings

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

surcharge
int32

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

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Updated 9 months ago

Language
Credentials
OAuth2
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
text/plain

Updated 9 months ago