v1

latestOpenAPI 3.1.02026-07-26460218.4 KB

Lookup Payment

Retrieve information about a specific payment

get/send/{id}

Path parameters

idstring required

Unique Send Identifier

Request body

{"stackTrail":"paths:/send/{id}:get:requestBody:content:application/json:schema","oasType":"schema","type":"unknown"}

Response

200

channelIdstring

sequenceIdstring

amountinteger

currencystring

countrystring

reasonstring

partnerIdstring

idstring

statusstring

sessionIdstring

convertedAmountinteger

ratenumber

expiresAtstring

createdAtstring

updatedAtstring

Example response

{
  "sender": {
    "name": "james",
    "country": "NG",
    "phone": "+12514218828",
    "address": "Home office, address1",
    "dob": "02/01/1997",
    "email": "justin@yellowcard.io",
    "idNumber": "12910293821",
    "idType": "passport"
  },
  "destination": {
    "accountName": "Héloïse D'arban",
    "accountNumber": "0760349371",
    "accountType": "bank",
    "networkId": "5f1af11b-305f-4420-8fce-65ed2725a409"
  },
  "channelId": "fe8f4989-3bf6-41ca-9621-ffe2bc127569",
  "sequenceId": "7707c304-4583-4077-9531-de3f7616659c",
  "amount": 50,
  "currency": "NGN",
  "country": "NG",
  "reason": "other",
  "partnerId": "9ecf5248-17e7-4a2b-b5a8-3bd58ff0fe01",
  "id": "9ae480ef-71cc-4ba3-9eb8-6970a8d707aa",
  "status": "complete",
  "sessionId": "0192102837711029102930",
  "convertedAmount": 20026,
  "rate": 400.52,
  "expiresAt": "2023-02-02T09:40:48.628Z",
  "createdAt": "2023-02-02T09:30:48.629Z",
  "updatedAt": "2023-02-02T09:30:48.629Z"
}