Create a payment transaction

Create a payment transaction using the active account of the member. The transaction created is in waiting state, in order to complete the transaction use capture or cancel endpoints. The operation is idempotent.

POST /v1/members/{memberId}/payments

Create a payment transaction

cURL

curl --request POST \
  --url https://{host}/bonus/v1/members/{memberId}/payments \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "operationId": "<string>",
  "amount": 123,
  "reserveAvailable": true,
  "metadata": {},
  "accountType": "<string>"
}
'

200

{
  "transactionId": 123,
  "reservedAmount": 123,
  "conversionRate": 123
}

Authorizations

Authorization · string · header · required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Path Parameters

memberId · string · required

The id of the member, max length 36.

Maximum string length: 36

Body

application/jsontext/jsonapplication/*+json

Reservation operation details.

operationId · string · required

Unique identifier of reserve operation (should be same only for retries of the same operation).

Required string length: 1 - 128

amount · number<double> · required

Amount to be reserved. Can be only positive.

reserveAvailable · boolean · required

Indicates whether to reserve account's available balance if it is less than amount to reserve.

metadata · object | null

Set of key-value pairs that you can attach to a payment transaction. This can be useful for storing additional information about the transaction in a structured format.

Show child attributes

accountType · string | null

Account type to be used (optional)

Response

200

application/json

OK

transactionId · integer<int64> · required

Unique transaction id of the reservation.

reservedAmount · number<double> · required

Amount which has been reserved.

conversionRate · number<double> · required

Amount which has been reserved.