POST
/
v2
/
remittances
curl --request POST \
  --url https://api.sandbox.pawapay.io/v2/remittances \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "remittanceId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "recipient": {
    "type": "MMO",
    "accountDetails": {
      "phoneNumber": "260763456789",
      "provider": "MTN_MOMO_ZMB"
    },
    "recipientDetails": {
      "firstName": "John",
      "lastName": "Doe"
    }
  },
  "sender": {
    "transactionDetails": {
      "transactionReference": "de83150a-5916-48a2-b048-bd85e022cb55",
      "originalAmount": "100",
      "originalCurrency": "USD",
      "buyFxRate": "23.88",
      "senderFees": "1 USD",
      "purposeOfFunds": "FAMILY_SUPPORT",
      "sourceOfFunds": "SALARY"
    },
    "senderDetails": {
      "firstName": "Jane",
      "lastName": "Doe",
      "nationality": "US",
      "gender": "FEMALE",
      "phoneNumber": "12124567890",
      "dateOfBirth": "1977-12-31",
      "placeOfBirth": "US",
      "occupation": "Project manager",
      "relationshipRecipient": "PARTNER",
      "address": {
        "addressLine": "1476 Sandhill Rd",
        "postalCode": "84058",
        "city": "Orem",
        "country": "US"
      },
      "identification": {
        "type": "PASSPORT",
        "number": "E00007730"
      }
    }
  },
  "customerMessage": "Note of 4 to 22 chars",
  "amount": "15",
  "currency": "ZMW",
  "metadata": [
    {
      "orderId": "ORD-123456789"
    },
    {
      "customerId": "customer@email.com",
      "isPII": true
    }
  ]
}'
{
  "remittanceId": "f4401bd2-1568-4140-bf2d-eb77d2b2b639",
  "status": "ACCEPTED",
  "created": "2020-10-19T11:17:01Z"
}

The remittance endpoint allows you to pay a customer.

  • This API call is idempotent, which means it is safe to submit a request with the same remittanceId multiple times.
  • Duplicate requests with the same remittanceId will be ignored with the DUPLICATE_IGNORED status in the response.
  • Since the request can be rejected, you must check the status code in the response for each submitted request. The failureReason in the response will contain information about the reason of the rejection.

Each request can get one of the statuses on initiation:

StatusDescription
ACCEPTEDYesThe remittance has been accepted by pawaPay for processing.
REJECTEDNoThe remittance has been rejected. See failureReason for details.
DUPLICATE_IGNOREDNoThe remittance has been ignored as a duplicate of an already accepted remittance. Duplication logic relies upon remittanceId.

Some data points in this endpoint are optional, but might be mandatory in specific markets.

Please see the country specific requirements for remittance requests.

​
How to find out the final status of this remittance?

As the pawaPay Merchant API is an asynchronous API, you can find out the final status of the ACCEPTED remittance by either:

Waiting for a callback

If you have configured callbacks, the callback with the final status of the remittance will be delivered to your callback URL.

Checking the status

Or poll the Check Remittance Status endpoint.

Headers related to signatures must only be included if you have enabled “Only accept signed requests”. Read more about it from the pawaPay Dashboard documentation.

Authorizations

​
Authorization
string
header
required

See Authentication.

Headers

​
Content-Digest
string

SHA-256 or SHA-512 hash of the request body.

​
Signature
string

Signature of the request according to RFC-9421.

​
Signature-Input
string

Signature input according to RFC-9421.

​
Accept-Signature
string

Expected signature algorithm of the response according to RFC-9421.

​
Accept-Digest
string

Expected digest algorithm of the response according to RFC-9421.

Body

application/json

Response

200
application/json

Request has been accepted for processing by pawaPay

The response is of type object.