Create

Create custom payment method schema

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringRequired
isSourcebooleanRequired
This payment method can be used as a payment source for an invoice
isDestinationbooleanRequired
This payment method can be used as a payment destination for an invoice
fieldslist of objectsRequired
supportedCurrencieslist of enumsOptional
List of currencies that this payment method supports. If not provided, the payment method will support only USD.
estimatedProcessingTimeintegerOptional

Estimated time in days for this payment method to process a payments. Set as 0 for same-day payment methods, -1 for unknown processing time.

maxAmountdoubleOptional
The maximum amount that can be transferred from this payment method in a single transaction.
minAmountdoubleOptional
The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.

Response

This endpoint returns an object.
idstring
namestring
isSourceboolean
This payment method can be used as a payment source for an invoice
isDestinationboolean
This payment method can be used as a payment destination for an invoice
supportedCurrencieslist of enums
List of currencies that this payment method supports.
fieldslist of objects
estimatedProcessingTimeinteger

Estimated time in days for this payment method to process a payments. 0 is an same-day payment methods, -1 is unknown processing time.

createdAtdatetime
updatedAtdatetime
maxAmountdouble or null
The maximum amount that can be transferred from this payment method in a single transaction.
minAmountdouble or null
The minimum amount that can be transferred from this payment method in a single transaction. Default is 1.

Errors