Skip to main content
GET
/
v1
/
request-money
/
{referenceId}
Get the public status of a request by `referenceId`
curl --request GET \
  --url https://banrural-request-api-sandbox.up.railway.app/v1/request-money/{referenceId} \
  --header 'X-API-Key: <api-key>'
{
  "status": "pending",
  "referenceId": "Ab3xY9mK",
  "id": "<string>",
  "statusDetails": "The operation is pending because the sender has not yet started the process.",
  "waLink": "https://wa.me/502123456789?text=Hola%20Juan,%20te%20enviamos%20una%20solicitud%20de%20dinero%20para%20pagar%20tu%20factura%20de%20agua#QWERTY",
  "landingLink": "https://landing.com/request-money/qwer-12345"
}

Authorizations

​
X-API-Key
string
header
required

Integrator API key.

Path Parameters

​
referenceId
string
required
Pattern: ^[a-zA-Z0-9]{8}$

Response

​
status
enum<string>
required

Public lifecycle status for the operation.

API valueDisplay labelStage / partyMeaning
pendingPendingSystem / requesterAwaiting payer action.
processingProcessingPayer / gatewayPayment in progress; not yet final.
completedCompletedPayment gatewaySuccessfully settled.
rejectedRejectedPayerPayer declined the payment.
cancelledCancelledRequesterIssuer cancelled the operation or it expired.
Available options:
pending,
processing,
completed,
rejected,
cancelled
Example:

"pending"

​
referenceId
string
required

Partner-provided operation code echoed from the create request (8 alphanumeric characters).

Example:

"Ab3xY9mK"

​
id
string
required
​
statusDetails
string
required

Details about the status of the operation.

Example:

"The operation is pending because the sender has not yet started the process."

​
waLink
string
required

Absolute WhatsApp link for the operation.

Example:

"https://wa.me/502123456789?text=Hola%20Juan,%20te%20enviamos%20una%20solicitud%20de%20dinero%20para%20pagar%20tu%20factura%20de%20agua#QWERTY"

​
landingLink
string
required

Absolute landing page URL for the operation.

Example:

"https://landing.com/request-money/qwer-12345"