Create Remitter

cURL

curl --request POST \
  --url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>' \
  --data '
{
  "first_name": "Siva",
  "last_name": "Raj",
  "nationality": "IND",
  "city": "Sydney",
  "source_of_funds": "gifts",
  "id_type": "PAN_CARD",
  "id_number": "AZL4546",
  "client_reference_id": "remitter-ref-001"
}
'

import requests

url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create"

payload = {
    "first_name": "Siva",
    "last_name": "Raj",
    "nationality": "IND",
    "city": "Sydney",
    "source_of_funds": "gifts",
    "id_type": "PAN_CARD",
    "id_number": "AZL4546",
    "client_reference_id": "remitter-ref-001"
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'Siva',
    last_name: 'Raj',
    nationality: 'IND',
    city: 'Sydney',
    source_of_funds: 'gifts',
    id_type: 'PAN_CARD',
    id_number: 'AZL4546',
    client_reference_id: 'remitter-ref-001'
  })
};

fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'first_name' => 'Siva',
    'last_name' => 'Raj',
    'nationality' => 'IND',
    'city' => 'Sydney',
    'source_of_funds' => 'gifts',
    'id_type' => 'PAN_CARD',
    'id_number' => 'AZL4546',
    'client_reference_id' => 'remitter-ref-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create"

	payload := strings.NewReader("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Remitter created",
  "data": {
    "id": "e14fa86f-2a5e-437a-a031-949c68ade933",
    "type": "PERSONAL",
    "status": "ACTIVE",
    "client_reference_id": "remitter-ref-001",
    "details": {}
  }
}

{
  "status": false,
  "message": "Bad Request",
  "err_code": "REQ_FIELD_MISSING",
  "errors": {
    "id_number": [
      "This field is required."
    ]
  },
  "data": null
}

{
  "status": false,
  "message": "Internal Server Error",
  "data": null,
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later."
}

POST

kyc

remitter

create

cURL

curl --request POST \
  --url https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --header 'X-SIGNATURE: <api-key>' \
  --header 'X-TIMESTAMP: <api-key>' \
  --data '
{
  "first_name": "Siva",
  "last_name": "Raj",
  "nationality": "IND",
  "city": "Sydney",
  "source_of_funds": "gifts",
  "id_type": "PAN_CARD",
  "id_number": "AZL4546",
  "client_reference_id": "remitter-ref-001"
}
'

import requests

url = "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create"

payload = {
    "first_name": "Siva",
    "last_name": "Raj",
    "nationality": "IND",
    "city": "Sydney",
    "source_of_funds": "gifts",
    "id_type": "PAN_CARD",
    "id_number": "AZL4546",
    "client_reference_id": "remitter-ref-001"
}
headers = {
    "X-API-KEY": "<api-key>",
    "X-TIMESTAMP": "<api-key>",
    "X-SIGNATURE": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'X-API-KEY': '<api-key>',
    'X-TIMESTAMP': '<api-key>',
    'X-SIGNATURE': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    first_name: 'Siva',
    last_name: 'Raj',
    nationality: 'IND',
    city: 'Sydney',
    source_of_funds: 'gifts',
    id_type: 'PAN_CARD',
    id_number: 'AZL4546',
    client_reference_id: 'remitter-ref-001'
  })
};

fetch('https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'first_name' => 'Siva',
    'last_name' => 'Raj',
    'nationality' => 'IND',
    'city' => 'Sydney',
    'source_of_funds' => 'gifts',
    'id_type' => 'PAN_CARD',
    'id_number' => 'AZL4546',
    'client_reference_id' => 'remitter-ref-001'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>",
    "X-SIGNATURE: <api-key>",
    "X-TIMESTAMP: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create"

	payload := strings.NewReader("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("X-TIMESTAMP", "<api-key>")
	req.Header.Add("X-SIGNATURE", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create")
  .header("X-API-KEY", "<api-key>")
  .header("X-TIMESTAMP", "<api-key>")
  .header("X-SIGNATURE", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://sandbox.dollarpe.xyz/cms/api/v1/kyc/remitter/create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["X-TIMESTAMP"] = '<api-key>'
request["X-SIGNATURE"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"Siva\",\n  \"last_name\": \"Raj\",\n  \"nationality\": \"IND\",\n  \"city\": \"Sydney\",\n  \"source_of_funds\": \"gifts\",\n  \"id_type\": \"PAN_CARD\",\n  \"id_number\": \"AZL4546\",\n  \"client_reference_id\": \"remitter-ref-001\"\n}"

response = http.request(request)
puts response.read_body

{
  "status": true,
  "message": "Remitter created",
  "data": {
    "id": "e14fa86f-2a5e-437a-a031-949c68ade933",
    "type": "PERSONAL",
    "status": "ACTIVE",
    "client_reference_id": "remitter-ref-001",
    "details": {}
  }
}

{
  "status": false,
  "message": "Bad Request",
  "err_code": "REQ_FIELD_MISSING",
  "errors": {
    "id_number": [
      "This field is required."
    ]
  },
  "data": null
}

{
  "status": false,
  "message": "Internal Server Error",
  "data": null,
  "err_code": "SYS_INTERNAL_ERROR",
  "errors": "Unexpected error occurred. Please try again later."
}

Create Remitter

Open in Cursor

Creating a remitter is idempotent: submitting the same id_type + id_number for your organization again returns the existing remitter’s id instead of creating a duplicate record.

customer_id is not part of this request. A remitter is a standalone record — it is not linked to one of your existing Customers.

Field notes

source_of_funds is a fixed enum (salary, savings, gifts, business_income, investment_proceeds, and others) — invalid values are rejected.
id_type is a fixed enum of supported identity document types: PASSPORT, DRIVING_LICENCE, BENEFICIARY_ID, PAN_CARD, AADHAAR_CARD, AIRLINE_STAFF_CARD, BUSINESS_REGISTRATION_NO_BR, CENTRAL_BANK_LICENCE, ACRA — invalid values are rejected.
nationality must be a 3-letter alpha code (format-checked only, e.g. IND, AUS).

Error Codes and Messages

API Status Code	Response	Reason
400	Bad Request	A required field is missing
400	Bad Request	`source_of_funds` is not one of the accepted values
400	Bad Request	`id_type` is not one of the accepted values
400	Bad Request	`first_name`, `last_name`, or `city` contains unsupported characters
400	Bad Request	`nationality` is not a 3-letter alpha code
500	Internal Server Error	Internal Server Error

Authorizations

X-API-KEY

string

header

required

API Key for authentication

X-TIMESTAMP

string

header

required

Current timestamp in seconds since epoch

X-SIGNATURE

string

header

required

HMAC SHA256 signature of the request encoded in Base64

Body

application/json

first_name

string

required

Letters, spaces, apostrophes, and hyphens only. 1-100 characters.

Example:

"Siva"

last_name

string

required

Letters, spaces, apostrophes, and hyphens only. 1-100 characters.

Example:

"Raj"

nationality

string

required

3-letter alpha country code (format-checked, uppercased on save; not validated against an ISO-3166 list).

Example:

"IND"

city

string

required

Letters, spaces, apostrophes, and hyphens only. 2-50 characters.

Example:

"Sydney"

source_of_funds

enum<string>

required

Fixed enum of accepted funding sources.

Available options:

business_income,

esops,

gambling_proceeds,

gifts,

government_benefits,

inheritance,

investment_loans,

investment_proceeds,

pension_retirement,

salary,

sale_of_assets_real_estate,

savings,

someone_else_funds,

credit_card,

crypto_currencies,

final_settlement,

funds_from_dividend_payouts,

funds_from_schemes_and_raffles,

gift_from_family_and_friends,

loan_from_bank,

other_sources

Example:

"gifts"

id_type

enum<string>

required

Type of identity document used for id_number.

Available options:

PASSPORT,

DRIVING_LICENCE,

BENEFICIARY_ID,

PAN_CARD,

AADHAAR_CARD,

AIRLINE_STAFF_CARD,

BUSINESS_REGISTRATION_NO_BR,

CENTRAL_BANK_LICENCE,

ACRA

Example:

"PAN_CARD"

id_number

string

required

Alphanumeric and hyphens only. 6-20 characters.

Example:

"AZL4546"

client_reference_id

string

Optional client-supplied reference for tracking. Max 255 characters.

Example:

"remitter-ref-001"

Response

Remitter created (or existing matching remitter returned)

status

boolean

Example:

true

message

string

Example:

"Remitter created"

data

object

Show child attributes

Fetch Bank Accounts

Configuration

Getting Started

Onramp (Payin)

Offramp (Payout)

Remittance Payout

Widget

Reference

Field notes

Error Codes and Messages

Authorizations

Body

Response

​Field notes

​Error Codes and Messages

Authorizations

Body

Response

Field notes

Error Codes and Messages