Offramps
Get offramp by external transfer ID
GET
/
offramps
/
by-external-transfer
/
{externalTransferId}
Get offramp by external transfer ID
curl --request GET \
--url http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"customerId": "<string>",
"receiveAddress": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"amount": "<string>",
"token": "<string>",
"network": "<string>",
"rate": "<string>",
"reference": "<string>",
"returnAddress": "<string>",
"status": "<string>",
"externalTransferId": "<string>",
"recipient": {
"institution": "<string>",
"accountIdentifier": "<string>",
"accountName": "<string>",
"currency": "<string>",
"memo": "<string>",
"providerId": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}Authorizations
API key created in the Remitflex Dashboard at dashboard.remitflex.io (rmf_live_... or rmf_test_...).
Key management endpoints require a dashboard JWT and are not part of this reference.
Path Parameters
⌘I
Get offramp by external transfer ID
curl --request GET \
--url http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId} \
--header 'Authorization: Bearer <token>'const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "http://localhost:4000/v1/offramps/by-external-transfer/{externalTransferId}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text){
"status": "success",
"message": "<string>",
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"orderId": "<string>",
"customerId": "<string>",
"receiveAddress": "<string>",
"validUntil": "2023-11-07T05:31:56Z",
"amount": "<string>",
"token": "<string>",
"network": "<string>",
"rate": "<string>",
"reference": "<string>",
"returnAddress": "<string>",
"status": "<string>",
"externalTransferId": "<string>",
"recipient": {
"institution": "<string>",
"accountIdentifier": "<string>",
"accountName": "<string>",
"currency": "<string>",
"memo": "<string>",
"providerId": "<string>"
},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
}