Skip to main content
POST
/
v1
/
request-money
curl --request POST \
  --url https://banrural-request-api-sandbox.up.railway.app/v1/request-money \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "referenceId": "OpBnK001",
  "expiresInMinutes": 120,
  "amount": 150.5,
  "currency": "GTQ",
  "requestData": {
    "userReferenceId": "user-8842",
    "name": {
      "firstName": "Maria",
      "lastName": "Lopez"
    },
    "address": {
      "country": "GT",
      "stateCode": "GT-01",
      "city": "Guatemala City",
      "line1": "12 Av. Reforma"
    },
    "dob": "1990-05-15T00:00:00.000Z",
    "payoutMethod": {
      "type": "bank_account",
      "bankAccount": {
        "country": "GT",
        "stateCode": "GT-01",
        "accountNumber": "0123456789012",
        "accountType": "checking",
        "bankCode": "BIND",
        "bankName": "BANCO INDUSTRIAL"
      }
    }
  }
}
'
{
  "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.

Body

application/json
​
requestData
object
required

End-user profile and payout method embedded in the request.

​
referenceId
string
required

Partner-provided operation code: exactly 8 characters from a-z, A-Z, and 0-9.

Pattern: ^[a-zA-Z0-9]{8}$
Example:

"Ab3xY9mK"

​
expiresInMinutes
number
required

Number of minutes the request-money operation will be valid.

Example:

120

​
amount
number
required

Amount of money to request.

Example:

100

​
currency
string
required

Currency code — ISO 4217 (three letters).

Example:

"GTQ"

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"