Paymend API documentation

Create a payment by submitting a POST request to /v1/payments.

Mandatory fields

The basic data required to create a payment relates to:

The value of the payment: amount and currency
The payment method to be used: passed in the PaymentMethod object
Payment identifiers:
- A merchant-defined unique identifier for the payment: merchantReference
- A Paymend-defined unique identifier for the store where the payment originated (eg. website): source.storeId
The type of goods being purchased: goodsType

Key fields

In addition to the details noted above which must be provided, we highly recommend passing the following details in all requests:

Who initiated the payment: source.initiatedBy is a valuable card-on-file parameter and is mandatory to enable asynchronous processing
Consumer and billing data: passed in the Consumer and Billing objects, respectively. These details increase the chances of approval and help with payment identification.
Determine the authorization type: use the captureNow field to actively determine whether funds are authorized and captured in a single or separate requests.

If you’re using Paymend for payment recovery, take a look at the PreviousFailure object too. See our guide on payment recovery via Paymend here.

Request

Example payment creation request (authorize and capture in one step):

{
  "amount": 12997,
  "currency": "USD",
  "merchantReference": "PAYMENT-12345",
  "goodsType": "MIXED",
  "captureNow": true,
  "source": {
    "storeId": "store_abc123",
    "initiatedBy": "CONSUMER"
  },
  "paymentMethod": {
    "type": "CARD",
    "card": {
      "number": "4111111111111111",
      "holderName": "John Doe",
      "cvv": "123",
      "expiryMonth": "12",
      "expiryYear": "2030",
      "brand": "VISA"
    }
  },
  "consumer": {
    "firstName": "John",
    "lastName": "Doe",
    "email": "john.doe@example.com"
  },
  "billing": {
    "address": {
      "street": "123 Main Street",
      "city": "San Francisco",
      "state": "CA",
      "zip": "94105",
      "country": "US"
    }
  }
}

Response

Example success response (200 OK):

{
  "paymentId": "pay_1234567890abcdef",
  "merchantReference": "PAYMENT-12345",
  "amount": 12997,
  "currency": "USD",
  "status": "CAPTURED",
  "goodsType": "MIXED",
  "captureNow": true,
  "source": {
    "storeId": "store_abc123",
    "initiatedBy": "CONSUMER"
  },
  "paymentMethod": {
    "type": "CARD",
    "card": {
      "bin": "41111111",
      "last4": "1111",
      "holderName": "John Doe",
      "expiryMonth": "12",
      "expiryYear": "2030",
      "brand": "VISA"
    }
  },
  "createdAt": "2024-01-15T10:30:00Z",
  "updatedAt": "2024-01-15T10:30:00Z",
  "transactions": [
    {
      "id": "SALE_pU2HnmS8AcpI",
      "type": "SALE",
      "amount": 12997,
      "result": "SUCCEEDED",
      "createdAt": "2024-01-15T10:30:00Z"
    }
  ]
}

Process payments

Create payments

Mandatory fields

Key fields

Request

Response

​Mandatory fields

​Key fields

​Request

​Response

Mandatory fields

Key fields

Request

Response