Send Cross Border Payments

POST /v2/payment-intents
//Create a new unsigned payment intent

{

"senderGatewayId": “[string] Payment Gateway ID of the sender.”,

"senderCurrency": “[string] Currency used by the sender.”,

"senderAccount": “[string] Sender Account.”,

"receiverGatewayId": “[string] Payment Gateway ID of the receiver.”,

"receiverAccount": “[string] Receiver account.”,

"receiverCurrency": “[string] Currency used by the receiver.”,

"receiverAmount": “[string] Amount in receiver currency the destination will receive.”,

"memo": “[string] memo associated with the payment.”,

"productType": “[string] (Optional): Type of product associated with the payment. Interswitch will provide this value when applicable.”

}

POST /v2/payments

//Creates a new signed payment
{

"senderGatewayId": “[string] Payment Gateway ID of the sender.”,

"senderCurrency": “[string] Currency used by the sender.”,

"senderAccount": “[string] Sender Account.”,

"receiverGatewayId": “[string] Payment Gateway ID of the receiver.”,

"receiverAccount": “[string] Receiver account.”,

"receiverCurrency": “[string] Currency used by the receiver.”,

"receiverAmount": “[string] Amount in receiver currency the destination will receive.”,

"memo": “[string] Memo associated with the payment.”,

"senderAmount": “[string] Amount sender has to pay, excluding sender fees.”,

"senderName": “[string] Name of the sender.”,

"receiverName": “[string] Name of the receiver.”,

"receivingGatewayFee": “[string] Amount in receiver currency charged by the receiving gateway.”,

"senderGatewayTransactionId": “[string] Transaction id generated by the sending gateway when sending a payment.”,

"senderGatewayTransactionChannel": “[string] Transaction channel used to perform payment. Use the value local for liquidity gateways. And pre-funded for non-liquidity gateway.”,

"productType": “[string] Type of product associated with the payment. If not provided during payment intent, the default value is account to account”,

"liqudityProviderId": “[string] Liqudity Provider ID. Required for certain gateways”,

"receiverBankCode": “[string] Receiver Bank Code. Required for certain gateways”,

"senderBankCode": “[string] Sender Bank Code. Required for certain gateways”,

}

export X_INTERSTELLAR_ERM_API_KEY=ocQPTBQUdhpCOeBznkJc8sM2rVu4iTFg

mkdir -p ~/.demo-rsa-keys

export TOKEN_ENDPOINT=https://id.pipechain-testnet.stargate.is/realms/interswitch-dev/protocol/openid-connect/token\;

export TOKEN_CLIENT_ID=interswitch-dev-api;

export API_ENDPOINT=https://dev-api-pipechain.qa.interswitchng.com

export MY_USERNAME="ng.bank.demo.ngn.api";

export MY_PASSWORD="abc";

export MY_TOKENS=`curl -s --request POST \
--url "$TOKEN_ENDPOINT" \
--data-urlencode grant_type='password' \
--data-urlencode username="$MY_USERNAME" \
--data-urlencode password="$MY_PASSWORD" \
--data-urlencode client_id="$TOKEN_CLIENT_ID"`

echo $MY_TOKENS

export MY_ACCESS_TOKEN=`echo $MY_TOKENS | jq -r ".access_token"`

echo $MY_ACCESS_TOKEN

export API_PAYLOAD=`jo -p -- \
senderGatewayId=ng.bank.demo.ngn \
senderCurrency=NGN \
senderAccount=SENDER_ACCOUNT \
receiverGatewayId=gh.bank.demo.ghs \
receiverAccount=RECEIVER_ACCOUNT \
receiverCurrency=GHS \
senderGatewayTransactionChannel=local \
-s memo="school fees" \
-s receiverAmount="1000"`

echo $API_PAYLOAD

export PAYMENT_INTENT_RESPONSE=`curl -s --request POST \
--url "$API_ENDPOINT/v2/payment-intents" \
--data "$API_PAYLOAD" \
--header  "accept: application/json" \
--header 'accept: */*' \
--header "Content-Type: application/json" \
--header "X_INTERSTELLAR_ERM_API_KEY: $X_INTERSTELLAR_ERM_API_KEY" \
--header "Authorization: Bearer $MY_ACCESS_TOKEN"`;

echo $PAYMENT_INTENT_RESPONSE

{
  "id": "6174094f-6b56-45ac-8c7b-688b511e0474",
  "senderGatewayId": "cm.wallet.interstellar-demo.xaf",
  "senderAmount": "1442.25",
  "senderCurrency": "XAF",
  "senderAccount": "fritz",
  "senderName": "Interstellar XAF 12345",
  "receiverGatewayId": "ng.wallet.interstellar-demo.ngn",
  "receiverAmount": "1000",
  "receiverCurrency": "NGN",
  "receiverAccount": "ernest",
  "receiverName": "Interstellar NGN 12345",
  "receivingGatewayFee": "100",
  "memo": "school fees",
  "extras": null
}

export PAYMENT_PAYLOAD=`echo $PAYMENT_INTENT_RESPONSE | jq '. +=  {"senderGatewayTransactionId":"'$(date +%s)'", "senderGatewayTransactionChannel": "local"}'`;

echo $PAYMENT_PAYLOAD

{
  "id": "168009ce-0d64-49f9-8b30-6ab481e38933",
  "senderGatewayId": "cm.wallet.interstellar-demo.xaf",
  "senderAmount": "1442.25",
  "senderCurrency": "XAF",
  "senderAccount": "fritz",
  "senderName": "Interstellar XAF 12345",
  "receiverGatewayId": "ng.wallet.interstellar-demo.ngn",
  "receiverAmount": "1000",
  "receiverCurrency": "NGN",
  "receiverAccount": "ernest",
  "receiverName": "Interstellar NGN 12345",
  "receivingGatewayFee": "100",
  "memo": "school fees",
  "extras": null,
  "senderGatewayTransactionId": "1674766017"
}

export PAYLOAD_SIGNATURE=`echo -n "/v2/payments$PAYMENT_PAYLOAD" | openssl dgst -sha256 -sign ~/.demo-rsa-keys/ng.bank.demo.ngn.priv | openssl enc -base64 -A`

echo $PAYLOAD_SIGNATURE

curl -s --request POST \
--url "$API_ENDPOINT/v2/payments" \
--data "$PAYMENT_PAYLOAD" \
--header  "accept: application/json" \
--header "X-PAPE-SIGNATURE-BASE64: $PAYLOAD_SIGNATURE" \
--header 'accept: */*' \
--header "Content-Type: application/json" \
--header "X_INTERSTELLAR_ERM_API_KEY: $X_INTERSTELLAR_ERM_API_KEY" \
--header "Authorization: Bearer $MY_ACCESS_TOKEN"

{
  "id": "b815154ea937554dd89dfcc09828b05f3e4187749a11d2bd5cda3bc304751660",
  "createdAt": "2023-01-26T20:58:20.968720171Z",
  "updatedAt": "2023-01-26T20:58:20.968720171Z",
  "pagingToken": "1674766700968-1091061797",
  "senderGatewayId": "cm.wallet.interstellar-demo.xaf",
  "senderAmount": "1442.25",
  "senderCurrency": "XAF",
  "senderAccount": "fritz",
  "senderName": "Interstellar XAF 12345",
  "receiverGatewayId": "ng.wallet.interstellar-demo.ngn",
  "receiverProcessingGatewayId": "ng.wallet.interstellar-demo.ngn",
  "receiverAmount": "1000",
  "receiverCurrency": "NGN",
  "receiverAccount": "ernest",
  "receiverName": "Interstellar NGN 12345",
  "senderGatewayStatus": "processed",
  "receiverGatewayStatus": "pending",
  "senderGatewayTransactionId": "1674766017",
  "receiverGatewayTransactionId": "",
  "senderGatewayPublicKey": "",
  "receiverGatewayPublicKey": "",
  "blockchainTransactionId": "d17a929ffc9978a73d24dd44eb655aeb78118a1245dd05e91f89b4f7d1f688fd",
  "receivingGatewayFee": "100",
  "memo": "school fees",
  "creationRequestUrl": "/payments",
  "creationRequestBody": "{\n  \"id\": \"168009ce-0d64-49f9-8b30-6ab481e38933\",\n  \"senderGatewayId\": \"cm.wallet.interstellar-demo.xaf\",\n  \"senderAmount\": \"1442.25\",\n  \"senderCurrency\": \"XAF\",\n  \"senderAccount\": \"fritz\",\n  \"senderName\": \"Interstellar XAF 12345\",\n  \"receiverGatewayId\": \"ng.wallet.interstellar-demo.ngn\",\n  \"receiverAmount\": \"1000\",\n  \"receiverCurrency\": \"NGN\",\n  \"receiverAccount\": \"ernest\",\n  \"receiverName\": \"Interstellar NGN 12345\",\n  \"receivingGatewayFee\": \"100\",\n  \"memo\": \"school fees\",\n  \"extras\": null,\n  \"senderGatewayTransactionId\": \"1674766017\"\n}",
  "creationRequestPublicKeyBase64": "LS0tLS1CRUdJTiBQVUJMSUMgS0VZLS0tLS0KTUlHZU1BMEdDU3FHU0liM0RRRUJBUVVBQTRHTUFEQ0JpQUtCZ0ZSYXlmRmxPKzhjYzVyUDNseERZT2JmbUViSgppTktQQWZDQ2FEemlyYyt6cU9xTFI1YkhTeklLTUMxN2lVTUpudGNGVUJZTjE1emZ4N3NVZW5qTlRPa29MVHVjCm5TRUhadzIyeFp4Uk05K0ZQTUpCaWw3bTl6cUdNZjU4Yk55UTAvTGl3cVhia3FXcHVPUzdmTnlOS2hNc2k0Q0wKdUhpMU5ncDh4YXdsM1Q1MUFnTUJBQUU9Ci0tLS0tRU5EIFBVQkxJQyBLRVktLS0tLQ==",
  "creationRequestSignatureBase64": "RZXZdHfmQ9XGDAbxM17Gzgq3IKimJgylwvuaJpbyZ2ogzwDa5HF5GPSobaVXobvHvlO+6nPjFZgdeMBdIta1xwOZUePAZ3SGbH/Z9MkdutVUxALehuSnWAV+5YlEfV96VeHHwHjzMvcDQjsdXQYVQH7Z6fOV0zpnl9+n8ByegEQ=",
  "extras": null
}