Send a P2P transfer to a beneficiary

POST

payments

p2p

beneficiary

curl --request POST \
  --url https://api.zeam.money/gw/v1/payments/p2p/beneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "idempotencyKey": "9d8c7b6a-5f4e-3d2c-1b0a-9f8e7d6c5b4a",
  "transactionId": "order-9933",
  "externalReference": "order-9933",
  "walletId": "66666666-6666-6666-6666-666666666666",
  "beneficiaryId": "77777777-7777-7777-7777-777777777777",
  "paymentDestinationId": "88888888-8888-8888-8888-888888888888",
  "sendingAssetCode": "USDZ",
  "amount": 50
}
'

{
  "transactionRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "accepted",
  "intentId": "<string>",
  "isIdempotent": true,
  "message": "<string>"
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Access token issued by POST /v1/auth/token.

x-zeam-auth

string

header

required

Application secret (the apiKey issued at registration), validated at the Kong edge.

Body

application/json

Same-asset payment to a registered beneficiary's CRYPTO payment destination. destinationWalletId is not accepted here.

idempotencyKey

string

required

transactionId

string

required

externalReference

string

required

walletId

string<uuid>

required

Source wallet.

beneficiaryId

string<uuid>

required

paymentDestinationId

string<uuid>

required

The beneficiary's CRYPTO payment destination.

sendingAssetCode

string

required

Asset to send — bare code. Issuer resolved server-side.

Example:

"USDZ"

amount

number

required

memo

string

notifyEmail

boolean

Notify the beneficiary by email. Requires a registered email. Mutually exclusive with notifyWhatsApp.

notifyWhatsApp

boolean

Notify the beneficiary by WhatsApp. Requires a registered mobile. Mutually exclusive with notifyEmail.

senderPhoneNumber

string

Response

Payment accepted for asynchronous processing.

A 202 means the submission was accepted for asynchronous execution, not that it settled. Track completion with the Transactions routes or webhooks.

transactionRecordId

string<uuid>

required

The transaction record id, used with GET /v1/transactions/{transactionId}.

status

string

required

Submission status; not a terminal transaction status.

Example:

"accepted"

intentId

string

Downstream intent id, when present.

isIdempotent

boolean

True when this response replays a prior submission with the same idempotencyKey.

message

string

Send multiple own-wallet P2P transfers atomically

Send a cross-asset swap between own wallets

Send a P2P transfer to a beneficiary

curl --request POST \
  --url https://api.zeam.money/gw/v1/payments/p2p/beneficiary \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-zeam-auth: <api-key>' \
  --data '
{
  "idempotencyKey": "9d8c7b6a-5f4e-3d2c-1b0a-9f8e7d6c5b4a",
  "transactionId": "order-9933",
  "externalReference": "order-9933",
  "walletId": "66666666-6666-6666-6666-666666666666",
  "beneficiaryId": "77777777-7777-7777-7777-777777777777",
  "paymentDestinationId": "88888888-8888-8888-8888-888888888888",
  "sendingAssetCode": "USDZ",
  "amount": 50
}
'

{
  "transactionRecordId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "status": "accepted",
  "intentId": "<string>",
  "isIdempotent": true,
  "message": "<string>"
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "type": "https://errors.zeam.app/validation-error",
  "title": "Validation Error",
  "status": 422,
  "detail": "The 'amount' field must be a positive decimal.",
  "instance": "/v1/quotes",
  "requestId": "01J8Z6K3QW9F2",
  "errors": [
    {
      "field": "<string>",
      "message": "<string>"
    }
  ]
}

Overview

Auth

Wallets

Assets

Beneficiaries

Connectors

Quotes

Payments

Transactions

Webhooks

Send a P2P transfer to a beneficiary

Authorizations

Body

Response