List letters
curl --request GET \
--url https://aropay.aro.media/api/v1/transfer/letter \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://aropay.aro.media/api/v1/transfer/letter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://aropay.aro.media/api/v1/transfer/letter"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"data": {
"items": [
{
"id": "cklet0001abcd",
"status": "DRAFT",
"chainId": 11155111,
"amount": "<string>",
"token": "cAROUSD",
"amountVisibility": "sealed",
"memo": "<string>",
"recipient": {
"name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"landmark": "<string>",
"city": "<string>",
"region": "<string>",
"postal": "<string>",
"country": "NG",
"countryName": "Nigeria"
}
},
"isDomestic": true,
"expiresAt": "2023-11-07T05:31:56Z",
"sender": {
"walletId": "<string>",
"address": "<string>"
},
"claimCode": "<string>",
"claimUrl": "<string>",
"pdfUrl": "<string>",
"escrow": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true
},
"claim": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true,
"claimedAt": "2023-11-07T05:31:56Z",
"walletAddress": "<string>"
},
"refund": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true,
"reason": "voided"
},
"mail": {
"provider": "lob",
"providerId": "<string>",
"deliveryMethod": "standard",
"status": "<string>",
"trackingNumber": "<string>",
"expectedDeliveryDate": "<string>",
"mailedAt": "2023-11-07T05:31:56Z",
"testMode": true
},
"needsReview": true,
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"page": 123,
"pageSize": 123,
"total": 123
}
}{
"ok": false,
"error": {
"code": "validation_error",
"message": "Request validation failed.",
"details": [
{
"path": "amount",
"message": "Required"
}
]
}
}{
"ok": false,
"error": {
"code": "invalid_api_key",
"message": "Invalid API key."
}
}{
"ok": false,
"error": {
"code": "account_disabled",
"message": "This account is disabled."
}
}{
"ok": false,
"error": {
"code": "rate_limited",
"message": "Too many requests. Try again shortly."
}
}{
"ok": false,
"error": {
"code": "internal_error",
"message": "An unexpected error occurred."
}
}Aro Mail
List letters
Your letters, newest first. In-flight rows are reconciled on read
(receipt lookups, amount verification, expiry detection) but this
endpoint never moves money or calls Lob. Items omit claimCode and
claimUrl; read a single letter for those.
GET
/
transfer
/
letter
List letters
curl --request GET \
--url https://aropay.aro.media/api/v1/transfer/letter \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://aropay.aro.media/api/v1/transfer/letter', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://aropay.aro.media/api/v1/transfer/letter"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"ok": true,
"data": {
"items": [
{
"id": "cklet0001abcd",
"status": "DRAFT",
"chainId": 11155111,
"amount": "<string>",
"token": "cAROUSD",
"amountVisibility": "sealed",
"memo": "<string>",
"recipient": {
"name": "<string>",
"address": {
"line1": "<string>",
"line2": "<string>",
"landmark": "<string>",
"city": "<string>",
"region": "<string>",
"postal": "<string>",
"country": "NG",
"countryName": "Nigeria"
}
},
"isDomestic": true,
"expiresAt": "2023-11-07T05:31:56Z",
"sender": {
"walletId": "<string>",
"address": "<string>"
},
"claimCode": "<string>",
"claimUrl": "<string>",
"pdfUrl": "<string>",
"escrow": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true
},
"claim": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true,
"claimedAt": "2023-11-07T05:31:56Z",
"walletAddress": "<string>"
},
"refund": {
"transactionId": "cktxn0005abcd",
"txHash": "<string>",
"explorerUrl": "<string>",
"status": "PENDING",
"verified": true,
"reason": "voided"
},
"mail": {
"provider": "lob",
"providerId": "<string>",
"deliveryMethod": "standard",
"status": "<string>",
"trackingNumber": "<string>",
"expectedDeliveryDate": "<string>",
"mailedAt": "2023-11-07T05:31:56Z",
"testMode": true
},
"needsReview": true,
"error": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
],
"page": 123,
"pageSize": 123,
"total": 123
}
}{
"ok": false,
"error": {
"code": "validation_error",
"message": "Request validation failed.",
"details": [
{
"path": "amount",
"message": "Required"
}
]
}
}{
"ok": false,
"error": {
"code": "invalid_api_key",
"message": "Invalid API key."
}
}{
"ok": false,
"error": {
"code": "account_disabled",
"message": "This account is disabled."
}
}{
"ok": false,
"error": {
"code": "rate_limited",
"message": "Too many requests. Try again shortly."
}
}{
"ok": false,
"error": {
"code": "internal_error",
"message": "An unexpected error occurred."
}
}Authorizations
apiKeyAuthsessionCookie
AroPay API key, sent as Authorization: Bearer aro_sk_…. Created in
the dashboard under Settings → API keys. Takes precedence over a
session cookie when both are present.
Query Parameters
Required range:
x >= 1Required range:
1 <= x <= 100Filter by letter status.
Available options:
DRAFT, ESCROWED, MAILED, CLAIMING, CLAIMED, EXPIRED, VOIDED, FAILED