Payment Requests

Get payment request by id

get

Path parameters

paymentRequestIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

idstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

tokenstringRequired

createdAtstring · date-timeRequired

updatedAtstring · date-timeRequired

verifyingAmountany ofRequired

or

undefined · enum · nullableOptionalPossible values:

verifyingPercentany ofRequired

numberOptional

or

undefined · enum · nullableOptionalPossible values:

receivedPercentnumberRequired

statusstring · enumRequiredPossible values:

typestring · enumRequiredPossible values:

hppPaymentRequestURLstring · uriRequired

virtualAccountIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

referencestringRequired

descriptionany ofRequired

stringOptional

or

undefined · enum · nullableOptionalPossible values:

destinationAccountany ofRequired

or

undefined · enum · nullableOptionalPossible values:

releaseConditionany ofRequired

or

undefined · enum · nullableOptionalPossible values:

destinationPaymentInstructionany ofRequired

or

undefined · enum · nullableOptionalPossible values:

invoiceany ofRequired

or

undefined · enum · nullableOptionalPossible values:

401

Default Response

application/json

404

Default Response

application/json

422

Default Response

application/json

get

/api/v1/payment-requests/{paymentRequestId}

HTTPcURLJavaScriptPython

GET /api/v1/payment-requests/{paymentRequestId} HTTP/1.1
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "token": "text",
  "createdAt": "2026-04-03T09:53:48.184Z",
  "updatedAt": "2026-04-03T09:53:48.184Z",
  "requestedAmount": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  },
  "receivedAmount": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  },
  "verifyingAmount": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  },
  "verifyingPercent": 1,
  "receivedPercent": 1,
  "status": "AWAITING_FUNDS",
  "type": "STANDARD",
  "hppPaymentRequestURL": "https://example.com",
  "payer": {
    "id": "text",
    "name": "text",
    "email": "text"
  },
  "virtualAccountId": "123e4567-e89b-12d3-a456-426614174000",
  "reference": "text",
  "description": "text",
  "destinationAccount": {
    "id": "text",
    "name": "text",
    "type": "internal"
  },
  "releaseCondition": {
    "releaseAt": "2026-04-03T09:53:48.184Z"
  },
  "transactions": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "txIdentifier": "text",
      "receivedAt": "2026-04-03T09:53:48.184Z",
      "obtainedAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "currentStatus": {
        "status": "CREATED",
        "description": "text",
        "createdAt": "2026-04-03T09:53:48.184Z"
      },
      "statusLogs": [
        {
          "status": "CREATED",
          "description": "text",
          "createdAt": "2026-04-03T09:53:48.184Z"
        }
      ],
      "senderPaymentIdentifiers": [
        {
          "type": "text",
          "value": "text"
        }
      ]
    }
  ],
  "destinationPaymentInstruction": {
    "asset": "USDC",
    "rail": "ETHEREUM"
  },
  "invoice": {
    "filename": "text",
    "mimeType": "text",
    "size": 1,
    "uploadedAt": "2026-04-03T09:53:48.184Z",
    "viewUrl": "text"
  }
}

Get payment requests

get

Query parameters

pageinteger · min: 1 · max: 9007199254740991OptionalDefault: 1

pageSizeinteger · min: 1 · max: 100OptionalDefault: 20

typestring · enumOptionalPossible values:

Responses

200

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

422

Default Response

application/json

get

/api/v1/payment-requests

HTTPcURLJavaScriptPython

GET /api/v1/payment-requests HTTP/1.1
Accept: */*

{
  "records": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "token": "text",
      "createdAt": "2026-04-03T09:53:48.184Z",
      "updatedAt": "2026-04-03T09:53:48.184Z",
      "requestedAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "receivedAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "verifyingAmount": {
        "amount": "text",
        "asset": "text",
        "scale": 1
      },
      "verifyingPercent": 1,
      "receivedPercent": 1,
      "status": "AWAITING_FUNDS",
      "type": "STANDARD",
      "hppPaymentRequestURL": "https://example.com",
      "payer": {
        "id": "text",
        "name": "text",
        "email": "text"
      },
      "virtualAccountId": "123e4567-e89b-12d3-a456-426614174000",
      "reference": "text",
      "description": "text",
      "destinationAccount": {
        "id": "text",
        "name": "text",
        "type": "internal"
      },
      "releaseCondition": {
        "releaseAt": "2026-04-03T09:53:48.184Z"
      }
    }
  ],
  "pagination": {
    "page": 1,
    "pageSize": 1,
    "totalItems": 1,
    "totalPages": 1
  }
}

Create a new payment request and a virtual account

post

Required scopes

This endpoint requires the following scopes:

• : Allows creating a new payment request.

Authorizations

every

OAuth2authorizationCodeRequired

Authorization URL: Token URL:

Body

application/json

identityIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

accountIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

destinationPaymentInstructionIdstring · uuidOptionalPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

feeOnTopbooleanRequired

amountstringRequiredPattern: ^[1-9]\d*$

scaleinteger · max: 18Required

emailany ofOptional

string · emailOptionalPattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

or

undefined · enum · nullableOptionalPossible values:

referencestring · max: 255Required

descriptionany ofOptional

string · max: 1000Optional

or

undefined · enum · nullableOptionalPossible values:

sendPaymentRequestLinkbooleanOptionalDefault: true

typestring · enumRequiredPossible values:

Responses

201

Default Response

application/json

400

Default Response

application/json

404

Default Response

application/json

post

/api/v1/payment-requests

HTTPcURLJavaScriptPython

POST /api/v1/payment-requests HTTP/1.1
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "identityId": "123e4567-e89b-12d3-a456-426614174000",
  "accountId": "123e4567-e89b-12d3-a456-426614174000",
  "destinationPaymentInstructionId": "123e4567-e89b-12d3-a456-426614174000",
  "feeOnTop": true,
  "amount": "text",
  "scale": 1,
  "email": "[email protected]",
  "reference": "text",
  "description": "text",
  "sendPaymentRequestLink": true,
  "type": "STANDARD",
  "releaseCondition": {
    "releaseAt": null
  }
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

Get the minimum single payment amount for a payment request by currency

get

Query parameters

currencystring · enumRequiredPossible values:

Responses

200

Default Response

application/json

401

Default Response

application/json

422

Default Response

application/json

get

/api/v1/payment-requests/minimum-amount

HTTPcURLJavaScriptPython

GET /api/v1/payment-requests/minimum-amount?currency=GBP HTTP/1.1
Accept: */*

{
  "minimumAmount": {
    "amount": "text",
    "asset": "text",
    "scale": 1
  }
}

Mark payment request as completed

post

Path parameters

paymentRequestIdstring · uuidRequiredPattern: ^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

Responses

200

Default Response

application/json

successbooleanRequired

messagestringRequired

400

Default Response

application/json

401

Default Response

application/json

404

Default Response

application/json

500

Default Response

application/json

post

/api/v1/payment-requests/{paymentRequestId}/mark-as-completed

HTTPcURLJavaScriptPython

POST /api/v1/payment-requests/{paymentRequestId}/mark-as-completed HTTP/1.1
Accept: */*

{
  "success": true,
  "message": "text"
}