custom-payment-method-schema

Update

Update custom payment method schema

post/paymentMethod/schema/{schemaId}

Request

  • Base URL: https://api.mercoa.com
  • URL: https://api.mercoa.com/paymentMethod/schema/{schemaId}
  • Auth: HTTP bearer

Path parameters

schemaIdstring required

Request body

namestring required
isSourceboolean required

This payment method can be used as a payment source for an invoice

isDestinationboolean required

This payment method can be used as a payment destination for an invoice

supportedCurrenciesPaymentMethodTypesCurrencyCode[]

List of currencies that this payment method supports. If not provided, the payment method will support only USD.

estimatedProcessingTimeinteger

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.

maxAmountnumber double

The maximum amount that can be transferred from this payment method in a single transaction.

minAmountnumber double

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

Response

Response with status 200

idstring required
namestring required
isSourceboolean required

This payment method can be used as a payment source for an invoice

isDestinationboolean required

This payment method can be used as a payment destination for an invoice

supportedCurrenciesPaymentMethodTypesCurrencyCode[] required

List of currencies that this payment method supports.

estimatedProcessingTimeinteger required

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

maxAmountnumber double

The maximum amount that can be transferred from this payment method in a single transaction.

minAmountnumber double

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

createdAtstring date-time required
updatedAtstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.