Beneficiary Management APIs

post

Create a beneficiary

Body

application/json

aliasstringOptional

external_referencestringOptional

first_namestringOptional

identity_referencestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary

application/json

post

/api/v1/beneficiary

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "addresses": [
    {
      "address": "text",
      "city": "text",
      "country": "text",
      "neighbourhood": "text",
      "post_code": "text",
      "state": "text"
    }
  ],
  "alias": "text",
  "contacts": [
    {
      "email": "text",
      "mobile_number": "text",
      "mobile_prefix": "text"
    }
  ],
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external_reference": "text",
  "first_name": "text",
  "identity_reference": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "created_at": "2026-01-23T12:15:09.504Z",
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

get

Get a coordinate by id

Path parameters

idstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/coordinates/{id}

application/json

get

/api/v1/beneficiary/coordinates/{id}

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/coordinates/{id} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/coordinates/{id}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "entity": {
    "affiliation": "CUSTOMER",
    "aspects": [
      {
        "aspect": {},
        "identifier": "123e4567-e89b-12d3-a456-426614174000",
        "relation": "text"
      }
    ],
    "reference": "text",
    "type": "INDIVIDUAL"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000"
}

post

Get additional attributes for a coordinate

Path parameters

identityReferencestringRequired

idRefstringRequired

Body

application/json

aliasstringOptional

currencystringRequired

first_namestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates

application/json

post

/api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 556

{
  "alias": "text",
  "coordinates": {
    "aba": "text",
    "account_code": "text",
    "account_number": "text",
    "address": "text",
    "bank_code": "text",
    "bank_name": "text",
    "beneficiary_verification_type": "text",
    "bic": "text",
    "branch_code": "text",
    "bsb": "text",
    "city": "text",
    "country": "text",
    "country_code": "text",
    "curp": "text",
    "iban": "text",
    "ifsc": "text",
    "neighbourhood": "text",
    "post_code": "text",
    "purpose_code": "text",
    "rfc": "text",
    "secondary_identification": "text",
    "sort_code": "text",
    "state": "text"
  },
  "currency": "text",
  "first_name": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

patch

Update a coordinate for a beneficiary

Path parameters

identityReferencestringRequired

idRefstringRequired

coordinateIdstring · uuidRequired

Body

application/json

aliasstringOptional

currencystringRequired

first_namestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates/{coordinateId}

application/json

patch

/api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates/{coordinateId}

HTTPcURLJavaScriptPython

PATCH /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates/{coordinateId} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 556

{
  "alias": "text",
  "coordinates": {
    "aba": "text",
    "account_code": "text",
    "account_number": "text",
    "address": "text",
    "bank_code": "text",
    "bank_name": "text",
    "beneficiary_verification_type": "text",
    "bic": "text",
    "branch_code": "text",
    "bsb": "text",
    "city": "text",
    "country": "text",
    "country_code": "text",
    "curp": "text",
    "iban": "text",
    "ifsc": "text",
    "neighbourhood": "text",
    "post_code": "text",
    "purpose_code": "text",
    "rfc": "text",
    "secondary_identification": "text",
    "sort_code": "text",
    "state": "text"
  },
  "currency": "text",
  "first_name": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary/dynamic/{identityReference}/{idRef}/coordinates/{coordinateId}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

post

Create beneficiary with identity

Path parameters

identityReferencestringRequired

Body

application/json

aliasstringOptional

external_referencestringOptional

first_namestringOptional

identity_referencestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/

application/json

post

/api/v1/beneficiary/identity/{identityReference}/

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/identity/{identityReference}/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "addresses": [
    {
      "address": "text",
      "city": "text",
      "country": "text",
      "neighbourhood": "text",
      "post_code": "text",
      "state": "text"
    }
  ],
  "alias": "text",
  "contacts": [
    {
      "email": "text",
      "mobile_number": "text",
      "mobile_prefix": "text"
    }
  ],
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external_reference": "text",
  "first_name": "text",
  "identity_reference": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary/identity/{identityReference}/

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

get

Get all beneficiaries by identity

Path parameters

identityReferencestringRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/list

application/json

get

/api/v1/beneficiary/identity/{identityReference}/list

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/identity/{identityReference}/list HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/list

[
  {
    "additional_fields": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "alias": "text",
    "beneficiary_internal_coordinates": [
      {
        "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
        "currencies": [
          "text"
        ],
        "is_verified": true,
        "last_payment_date": "2026-01-23T12:15:09.504Z"
      }
    ],
    "contact_hash_list": [
      "text"
    ],
    "created_at": "2026-01-23T12:15:09.504Z",
    "dynamic_beneficiary_coords": [
      {
        "alias": "text",
        "bank_name": "text",
        "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
        "coordinates": {
          "aba": "text",
          "account_code": "text",
          "account_number": "text",
          "address": "text",
          "bank_code": "text",
          "bank_name": "text",
          "beneficiary_verification_type": "text",
          "bic": "text",
          "branch_code": "text",
          "bsb": "text",
          "city": "text",
          "country": "text",
          "country_code": "text",
          "curp": "text",
          "iban": "text",
          "ifsc": "text",
          "neighbourhood": "text",
          "post_code": "text",
          "purpose_code": "text",
          "rfc": "text",
          "sort_code": "text",
          "state": "text"
        },
        "currency": "text",
        "first_name": "text",
        "is_verified": true,
        "last_name": "text",
        "last_payment_date": "2026-01-23T12:15:09.504Z",
        "organization_name": "text",
        "payment_type": "text",
        "primary_coordinate_formats": [
          "text"
        ],
        "primary_coordinates": [
          "text"
        ]
      }
    ],
    "external_reference": "text",
    "first_name": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "last_name": "text",
    "organization_name": "text",
    "updated_at": "2026-01-23T12:15:09.504Z"
  }
]

get

Get recently paid beneficiaries

Path parameters

identityReferencestringRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/payments

application/json

get

/api/v1/beneficiary/identity/{identityReference}/payments

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/identity/{identityReference}/payments HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/payments

[
  {
    "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
    "beneficiary_id": "123e4567-e89b-12d3-a456-426614174000",
    "created_at": "2026-01-23T12:15:09.504Z",
    "payment_key": "text"
  }
]

post

Sync beneficiaries

Path parameters

identityReferencestringRequired

Body

application/json

Request to sync contacts of a customer phonebook with list of beneficiaries.

contact_hashesstring[]Required

The contact hashes of a customer phonebook that will be synced.

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/sync

No content

post

/api/v1/beneficiary/identity/{identityReference}/sync

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/identity/{identityReference}/sync HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 27

{
  "contact_hashes": [
    "text"
  ]
}

200

Response to /api/v1/beneficiary/identity/{identityReference}/sync

No content

get

Resend verification OTP to a beneficiary

Path parameters

identityReferencestringRequired

verificationUuidstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

application/json

get

/api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

{
  "beneficiary_coordinate_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "beneficiary_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "VERIFIED",
  "verification_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

post

Verify OTP for a beneficiary

Path parameters

identityReferencestringRequired

verificationUuidstring · uuidRequired

Body

application/json

otpstringRequired

One time passcode for beneficiary coordinate verification

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

application/json

post

/api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 14

{
  "otp": "text"
}

200

Response to /api/v1/beneficiary/identity/{identityReference}/verification/{verificationUuid}

{
  "beneficiary_coordinate_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "beneficiary_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "VERIFIED",
  "verification_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

Get a beneficiary by idRef

Path parameters

identityReferencestringRequired

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}

application/json

get

/api/v1/beneficiary/identity/{identityReference}/{idRef}

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/identity/{identityReference}/{idRef} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

patch

Update beneficiary with identity

Path parameters

identityReferencestringRequired

idRefstringRequired

Body

application/json

aliasstringOptional

external_referencestringOptional

first_namestringOptional

identity_referencestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}

application/json

patch

/api/v1/beneficiary/identity/{identityReference}/{idRef}

HTTPcURLJavaScriptPython

PATCH /api/v1/beneficiary/identity/{identityReference}/{idRef} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "addresses": [
    {
      "address": "text",
      "city": "text",
      "country": "text",
      "neighbourhood": "text",
      "post_code": "text",
      "state": "text"
    }
  ],
  "alias": "text",
  "contacts": [
    {
      "email": "text",
      "mobile_number": "text",
      "mobile_prefix": "text"
    }
  ],
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external_reference": "text",
  "first_name": "text",
  "identity_reference": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

post

Add a coordinate to a beneficiary

Path parameters

identityReferencestringRequired

idRefstringRequired

Body

application/json

A standard way of transmitting account coordinates between services.

referencestringOptional

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/

application/json

post

/api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/ HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 796

{
  "acceptor": {
    "acquirer_id": "text",
    "facilitator_id": "text",
    "id": "text",
    "mcc": "text",
    "terminal_id": "text"
  },
  "banking": {
    "account_code": "text",
    "account_number": "text",
    "account_type": "text",
    "balance_account_number": "text",
    "bank_code": "text",
    "bic": "text",
    "bic_bank_code": "text",
    "bic_branch_code": "text",
    "bic_location_code": "text",
    "branch_code": "text",
    "country_code": "text",
    "currency": "text",
    "iban": "text",
    "national_id": "text",
    "owner_account_number": "text",
    "routing_code": "text"
  },
  "external": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "internal": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "account_reference": "text",
    "card_id": "123e4567-e89b-12d3-a456-426614174000",
    "contact_account_id": "text",
    "currency_code": "text",
    "legacy_account_id": 1,
    "wallet_address": "text",
    "wallet_code": "text"
  },
  "reference": "text"
}

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/

{
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tags": [
    "text"
  ]
}

delete

Delete a coordinate from a beneficiary

Path parameters

identityReferencestringRequired

idRefstringRequired

coordinateIdstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}

No content

delete

/api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}

HTTPcURLJavaScriptPython

DELETE /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}

No content

post

Add a category to a coordinate

Path parameters

identityReferencestringRequired

idRefstringRequired

coordinateIdstring · uuidRequired

categorystringRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/category/{category}

No content

post

/api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/category/{category}

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/category/{category} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/category/{category}

No content

get

Send verification OTP to a beneficiary

Path parameters

identityReferencestringRequired

idRefstringRequired

coordinateIdstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/verification

application/json

get

/api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/verification

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/verification HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/identity/{identityReference}/{idRef}/coordinates/{coordinateId}/verification

{
  "beneficiary_coordinate_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "beneficiary_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "status": "VERIFIED",
  "verification_uuid": "123e4567-e89b-12d3-a456-426614174000"
}

get

Get a beneficiary by idRef

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}

application/json

get

/api/v1/beneficiary/{idRef}

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/{idRef} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "created_at": "2026-01-23T12:15:09.504Z",
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

delete

Delete a beneficiary

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}

No content

delete

/api/v1/beneficiary/{idRef}

HTTPcURLJavaScriptPython

DELETE /api/v1/beneficiary/{idRef} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}

No content

patch

Update a beneficiary

Path parameters

idRefstringRequired

Body

application/json

aliasstringOptional

external_referencestringOptional

first_namestringOptional

identity_referencestringOptional

last_namestringOptional

organization_namestringOptional

Responses

200

Response to /api/v1/beneficiary/{idRef}

application/json

patch

/api/v1/beneficiary/{idRef}

HTTPcURLJavaScriptPython

PATCH /api/v1/beneficiary/{idRef} HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 1201

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "addresses": [
    {
      "address": "text",
      "city": "text",
      "country": "text",
      "neighbourhood": "text",
      "post_code": "text",
      "state": "text"
    }
  ],
  "alias": "text",
  "contacts": [
    {
      "email": "text",
      "mobile_number": "text",
      "mobile_prefix": "text"
    }
  ],
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external_reference": "text",
  "first_name": "text",
  "identity_reference": "text",
  "last_name": "text",
  "organization_name": "text"
}

200

Response to /api/v1/beneficiary/{idRef}

{
  "additional_fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "alias": "text",
  "beneficiary_internal_coordinates": [
    {
      "account_uuid": "123e4567-e89b-12d3-a456-426614174000",
      "currencies": [
        "text"
      ],
      "is_verified": true,
      "last_payment_date": "2026-01-23T12:15:09.504Z"
    }
  ],
  "contact_hash_list": [
    "text"
  ],
  "created_at": "2026-01-23T12:15:09.504Z",
  "dynamic_beneficiary_coords": [
    {
      "alias": "text",
      "bank_name": "text",
      "beneficiary_coordinate_id": "123e4567-e89b-12d3-a456-426614174000",
      "coordinates": {
        "aba": "text",
        "account_code": "text",
        "account_number": "text",
        "address": "text",
        "bank_code": "text",
        "bank_name": "text",
        "beneficiary_verification_type": "text",
        "bic": "text",
        "branch_code": "text",
        "bsb": "text",
        "city": "text",
        "country": "text",
        "country_code": "text",
        "curp": "text",
        "iban": "text",
        "ifsc": "text",
        "neighbourhood": "text",
        "post_code": "text",
        "purpose_code": "text",
        "rfc": "text",
        "sort_code": "text",
        "state": "text"
      },
      "currency": "text",
      "first_name": "text",
      "is_verified": true,
      "last_name": "text",
      "last_payment_date": "2026-01-23T12:15:09.504Z",
      "organization_name": "text",
      "payment_type": "text",
      "primary_coordinate_formats": [
        "text"
      ],
      "primary_coordinates": [
        "text"
      ]
    }
  ],
  "external_reference": "text",
  "first_name": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_name": "text",
  "organization_name": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

get

Get additional attributes for a beneficiary

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/additional-attributes

application/json

get

/api/v1/beneficiary/{idRef}/additional-attributes

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/{idRef}/additional-attributes HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/additional-attributes

{
  "ANY_ADDITIONAL_PROPERTY": "text"
}

get

Get addresses for a beneficiary

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/address

application/json

get

/api/v1/beneficiary/{idRef}/address

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/{idRef}/address HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/address

[
  {
    "address": "text",
    "city": "text",
    "country": "text",
    "created_at": "2026-01-23T12:15:09.504Z",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "neighbourhood": "text",
    "post_code": "text",
    "state": "text",
    "updated_at": "2026-01-23T12:15:09.504Z"
  }
]

post

Add an address to a beneficiary

Path parameters

idRefstringRequired

Body

application/json

addressstringRequired

citystringRequired

countrystringRequired

neighbourhoodstringRequired

post_codestringRequired

statestringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/address

application/json

post

/api/v1/beneficiary/{idRef}/address

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/{idRef}/address HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 106

{
  "address": "text",
  "city": "text",
  "country": "text",
  "neighbourhood": "text",
  "post_code": "text",
  "state": "text"
}

200

Response to /api/v1/beneficiary/{idRef}/address

{
  "address": "text",
  "city": "text",
  "country": "text",
  "created_at": "2026-01-23T12:15:09.504Z",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "neighbourhood": "text",
  "post_code": "text",
  "state": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

delete

Delete an address from a beneficiary

Path parameters

idRefstringRequired

addressIdstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/address/{addressId}

No content

delete

/api/v1/beneficiary/{idRef}/address/{addressId}

HTTPcURLJavaScriptPython

DELETE /api/v1/beneficiary/{idRef}/address/{addressId} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/address/{addressId}

No content

get

Get contacts for a beneficiary

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/contact

application/json

get

/api/v1/beneficiary/{idRef}/contact

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/{idRef}/contact HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/contact

[
  {
    "created_at": "2026-01-23T12:15:09.504Z",
    "email": "text",
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "mobile_number": "text",
    "mobile_prefix": "text",
    "updated_at": "2026-01-23T12:15:09.504Z"
  }
]

post

Add a contact to a beneficiary

Path parameters

idRefstringRequired

Body

application/json

emailstringRequired

mobile_numberstringRequired

mobile_prefixstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/contact

application/json

post

/api/v1/beneficiary/{idRef}/contact

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/{idRef}/contact HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 62

{
  "email": "text",
  "mobile_number": "text",
  "mobile_prefix": "text"
}

200

Response to /api/v1/beneficiary/{idRef}/contact

{
  "created_at": "2026-01-23T12:15:09.504Z",
  "email": "text",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "mobile_number": "text",
  "mobile_prefix": "text",
  "updated_at": "2026-01-23T12:15:09.504Z"
}

delete

Delete a contact from a beneficiary

Path parameters

idRefstringRequired

contactIdstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/contact/{contactId}

No content

delete

/api/v1/beneficiary/{idRef}/contact/{contactId}

HTTPcURLJavaScriptPython

DELETE /api/v1/beneficiary/{idRef}/contact/{contactId} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/contact/{contactId}

No content

get

Get coordinates for a beneficiary

Path parameters

idRefstringRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/coordinates

application/json

get

/api/v1/beneficiary/{idRef}/coordinates

HTTPcURLJavaScriptPython

GET /api/v1/beneficiary/{idRef}/coordinates HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/coordinates

[
  {
    "coordinates": {
      "acceptor": {
        "acquirer_id": "text",
        "facilitator_id": "text",
        "id": "text",
        "mcc": "text",
        "terminal_id": "text"
      },
      "banking": {
        "account_code": "text",
        "account_number": "text",
        "account_type": "text",
        "balance_account_number": "text",
        "bank_code": "text",
        "bic": "text",
        "bic_bank_code": "text",
        "bic_branch_code": "text",
        "bic_location_code": "text",
        "branch_code": "text",
        "country_code": "text",
        "currency": "text",
        "iban": "text",
        "national_id": "text",
        "owner_account_number": "text",
        "routing_code": "text"
      },
      "external": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "internal": {
        "account_id": "123e4567-e89b-12d3-a456-426614174000",
        "account_reference": "text",
        "card_id": "123e4567-e89b-12d3-a456-426614174000",
        "contact_account_id": "text",
        "currency_code": "text",
        "legacy_account_id": 1,
        "wallet_address": "text",
        "wallet_code": "text"
      },
      "reference": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "tags": [
      "text"
    ]
  }
]

post

Add a coordinate to a beneficiary

Path parameters

idRefstringRequired

Body

application/json

A standard way of transmitting account coordinates between services.

referencestringOptional

Responses

200

Response to /api/v1/beneficiary/{idRef}/coordinates

application/json

post

/api/v1/beneficiary/{idRef}/coordinates

HTTPcURLJavaScriptPython

POST /api/v1/beneficiary/{idRef}/coordinates HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 796

{
  "acceptor": {
    "acquirer_id": "text",
    "facilitator_id": "text",
    "id": "text",
    "mcc": "text",
    "terminal_id": "text"
  },
  "banking": {
    "account_code": "text",
    "account_number": "text",
    "account_type": "text",
    "balance_account_number": "text",
    "bank_code": "text",
    "bic": "text",
    "bic_bank_code": "text",
    "bic_branch_code": "text",
    "bic_location_code": "text",
    "branch_code": "text",
    "country_code": "text",
    "currency": "text",
    "iban": "text",
    "national_id": "text",
    "owner_account_number": "text",
    "routing_code": "text"
  },
  "external": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "internal": {
    "account_id": "123e4567-e89b-12d3-a456-426614174000",
    "account_reference": "text",
    "card_id": "123e4567-e89b-12d3-a456-426614174000",
    "contact_account_id": "text",
    "currency_code": "text",
    "legacy_account_id": 1,
    "wallet_address": "text",
    "wallet_code": "text"
  },
  "reference": "text"
}

200

Response to /api/v1/beneficiary/{idRef}/coordinates

{
  "coordinates": {
    "acceptor": {
      "acquirer_id": "text",
      "facilitator_id": "text",
      "id": "text",
      "mcc": "text",
      "terminal_id": "text"
    },
    "banking": {
      "account_code": "text",
      "account_number": "text",
      "account_type": "text",
      "balance_account_number": "text",
      "bank_code": "text",
      "bic": "text",
      "bic_bank_code": "text",
      "bic_branch_code": "text",
      "bic_location_code": "text",
      "branch_code": "text",
      "country_code": "text",
      "currency": "text",
      "iban": "text",
      "national_id": "text",
      "owner_account_number": "text",
      "routing_code": "text"
    },
    "external": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "internal": {
      "account_id": "123e4567-e89b-12d3-a456-426614174000",
      "account_reference": "text",
      "card_id": "123e4567-e89b-12d3-a456-426614174000",
      "contact_account_id": "text",
      "currency_code": "text",
      "legacy_account_id": 1,
      "wallet_address": "text",
      "wallet_code": "text"
    },
    "reference": "text"
  },
  "external": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "tags": [
    "text"
  ]
}

delete

Delete a coordinate from a beneficiary

Path parameters

idRefstringRequired

coordinateIdstring · uuidRequired

Responses

200

Response to /api/v1/beneficiary/{idRef}/coordinates/{coordinateId}

No content

delete

/api/v1/beneficiary/{idRef}/coordinates/{coordinateId}

HTTPcURLJavaScriptPython

DELETE /api/v1/beneficiary/{idRef}/coordinates/{coordinateId} HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/beneficiary/{idRef}/coordinates/{coordinateId}

No content

get

Get contact account field specifications

Path parameters

identityReferencestringRequired

Responses

200

Response to /api/v1/fields/{identityReference}/contact-account

application/json

get

/api/v1/fields/{identityReference}/contact-account

HTTPcURLJavaScriptPython

GET /api/v1/fields/{identityReference}/contact-account HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/fields/{identityReference}/contact-account

{
  "spec": {
    "ANY_ADDITIONAL_PROPERTY": {
      "field_groups": [
        {
          "fields": [
            {
              "additional_info": {
                "link": "text",
                "localized_text": "text"
              },
              "input": {
                "constraints": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "key": "text",
                "options": [
                  {
                    "key": "text",
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                ],
                "required_conditions": [
                  {
                    "depends_on": "text",
                    "selected_option": "text",
                    "selected_options": [
                      "text"
                    ],
                    "type": "text"
                  }
                ],
                "tags": [
                  "text"
                ],
                "type": "text"
              },
              "input_pattern": "text",
              "localized_hint": "text",
              "localized_name": "text",
              "option_decorations": [
                {
                  "key": "text",
                  "localized_name": "text"
                }
              ],
              "tags": [
                "text"
              ],
              "visibility_conditions": [
                {
                  "depends_on": "text",
                  "selected_option": "text",
                  "selected_options": [
                    "text"
                  ],
                  "type": "text"
                }
              ]
            }
          ],
          "localized_name": "text"
        }
      ],
      "field_order": [
        "text"
      ]
    }
  }
}

get

Get payment creation field specifications

Path parameters

identityReferencestringRequired

Query parameters

beneficiaryAccountIdOptionalstring · uuidOptional

Responses

200

Response to /api/v1/fields/{identityReference}/payment

application/json

get

/api/v1/fields/{identityReference}/payment

HTTPcURLJavaScriptPython

GET /api/v1/fields/{identityReference}/payment HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/fields/{identityReference}/payment

{
  "spec": {
    "ANY_ADDITIONAL_PROPERTY": {
      "field_groups": [
        {
          "fields": [
            {
              "additional_info": {
                "link": "text",
                "localized_text": "text"
              },
              "input": {
                "constraints": [
                  {
                    "key": "text",
                    "value": "text"
                  }
                ],
                "key": "text",
                "options": [
                  {
                    "key": "text",
                    "properties": {
                      "ANY_ADDITIONAL_PROPERTY": "text"
                    }
                  }
                ],
                "required_conditions": [
                  {
                    "depends_on": "text",
                    "selected_option": "text",
                    "selected_options": [
                      "text"
                    ],
                    "type": "text"
                  }
                ],
                "tags": [
                  "text"
                ],
                "type": "text"
              },
              "input_pattern": "text",
              "localized_hint": "text",
              "localized_name": "text",
              "option_decorations": [
                {
                  "key": "text",
                  "localized_name": "text"
                }
              ],
              "tags": [
                "text"
              ],
              "visibility_conditions": [
                {
                  "depends_on": "text",
                  "selected_option": "text",
                  "selected_options": [
                    "text"
                  ],
                  "type": "text"
                }
              ]
            }
          ],
          "localized_name": "text"
        }
      ],
      "field_order": [
        "text"
      ]
    }
  }
}

post

Validate payment creation

Path parameters

identityReferencestringRequired

Body

application/json

beneficiary_account_uuidstring · uuidRequired

beneficiary_uuidstring · uuidRequired

currencystringRequired

Responses

200

Response to /api/v1/fields/{identityReference}/payment/validate

application/json

post

/api/v1/fields/{identityReference}/payment/validate

HTTPcURLJavaScriptPython

POST /api/v1/fields/{identityReference}/payment/validate HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 187

{
  "beneficiary_account_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "beneficiary_uuid": "123e4567-e89b-12d3-a456-426614174000",
  "currency": "text",
  "fields": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  }
}

200

Response to /api/v1/fields/{identityReference}/payment/validate

{
  "violations": [
    {
      "key": "text",
      "localized_message": "text"
    }
  ]
}

post

Interrupt the synchronization process

Responses

200

Response to /api/v1/sync/interrupt

No content

post

/api/v1/sync/interrupt

HTTPcURLJavaScriptPython

POST /api/v1/sync/interrupt HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/sync/interrupt

No content

post

Manually initiate the synchronization process

Responses

200

Response to /api/v1/sync/manual

No content

post

/api/v1/sync/manual

HTTPcURLJavaScriptPython

POST /api/v1/sync/manual HTTP/1.1
Host: 
Accept: */*

200

Response to /api/v1/sync/manual

No content