Create Charge

post

https://test.api.promisepay.com/charges

Create a Charge. Charges require a specified Card Account or Bank Account. You may pass through an existing User, or define the user_id of the new user that will be associated with the Charge and the provided Account. The user_id can be left blank if you wish for a new user to be created for the Charge, or specified if you wish for a new User to be created with the passed user_id.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

account_id

string

required

Defaults to 5ef44050-4c56-0137-abdf-0242ac110002

Bank Account or Card Account ID

name

string

Description of the Charge being created.

amount

integer

required

The cost being charged in cents.

string

required

Defaults to [email protected]

Email of the user associated with the account being charged.

zip

integer

required

Postcode

country

string

required

Defaults to AUS

ISO 3166-1 alpha-3 country code of the User being charged.

user_id

string

The ID of the User

fee_ids

string

A comma separated list of fee IDs to apply

currency

string

ISO 4217 alpha-3 currency code. This is an optional field and if not provided, the item will be created with the default currency of the marketplace.

retain_account

boolean

True - Enables the account to be charged in the future. False - Redacts the account after this charge.

device_id

string

Device Information for the device initiating the payment

ip_address

string

IP Information for the device initiating the payment

custom_descriptor

string

When custom_descriptors are enabled, this is the information to appear on credit card and direct debit statements.

cvv

string

CVV / CVC

Response

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

201OK