Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-2265186296.2 KB
Transactions

Create a payment transaction

Use this endpoint to create a payment transaction. You can find sample code in our public Postman collection, or build it in the adjacent API explorer. The link to our postman collection is: https://www.postman.com/meldeng/workspace/meld-io-public-api-collection

IDEMPOTENT REQUESTS: Please refer to Idempotency Key

PASSTHROUGH ENABLED REQUESTS: Please refer to Passthrough Headers

ERRORS: Please refer to Error Responses

post/payments/transactions

Headers

X-Idempotency-Keystring uuid
Meld-Passthrough-Referencestring
Meld-Passthrough-Key-Idstring
Meld-Passthrough-Key-Publicstring
Meld-Passthrough-Key-Privatestring
Meld-Passthrough-Oauthstring

Request body

captureboolean

Should the payment be captured immediately, if set to false an authorization will be performed instead

customerIdstring

Meld's internal Id for the Customer

descriptionstring

A description about the transaction

externalCustomerIdstring

Your (optional) Id for this customer, for example an id or reference from your database which you may supply during customer creation

noncestring

A payment method nonce is a secure, one-time-use reference to payment information. It's the key element that allows your server to communicate sensitive payment information to the service provider without ever touching the raw data.

serviceProvider'AUTHORIZENET' | 'BRAINTREE' | 'CHECKOUT' | 'CIRCLE' | 'NMI' | 'STRIPE'

The service provider used for this transaction. Required when using a nonce or passthrough credentials, as they are tied to a specific service provider. Do not pass this in if you would like to use routing to select a service provider.

serviceProviderDetailsobject

Provider specific details which may can be provided for this transaction, if supported by the Service Provider. For example, you can set a custom billing descriptor for your transaction using Checkout.com

sourceAmountstring required

Amount intended to be collected by this payment

sourceCurrencyCodestring required

Three-letter ISO currency code, in lowercase. Must be a supported currency

Example request

{
  "paymentMethod": {
    "details": {
      "cvc": "123",
      "number": "4111111111111111"
    }
  },
  "sourceAmount": "10.50",
  "sourceCurrencyCode": "USD"
}

Response

Payment transaction created successfully