Register Operation
Register Operation
POST
https://api.payvalida.com/cashout/v1/operation
URL Sandbox: https://api-test.payvalida.com/v1
/operation/
This method registers a cashout operation, authorizing the delivery of cash to the requester
Request Body
Name | Type | Description |
---|---|---|
merchant | string | ID of the commerce/merchant that owns the operation (Max 30 characters). |
checksum | string | Checksum encoded in SHA512 (merchant+operation+amount+currency+ document+FIXED_HASH) (512 characters). |
operation | string | Operation ID generated by the commerce/merchant. Must be unique (40 characters). |
amount | number | Operation amount (20 characters) *In Peru it must only contain one decimal digit |
currency | string | ISO code of the currency of the operation (3 characters) |
description | string | Short description of the operation (Max 50 characters) |
document | number | ID of the end user that executes the operation (Max 20 characters) |
otpLength | number | Length of the OTP (default 4, 4 <= otpLength <= 12) (between 4 and 12 characters) |
expire | string | Expiration date of the operation (YYYY-MM-DD format, default 30 days) (8 characters). |
transactionCost | number | Amount the commerce will charge the user for the operation (default 0) (Max 10 characters). |
beneficiaryDocumentType | string | Type of document of the person who will receive the money. Allowed values Peru: - DNI - RUC - CE *Required for Peru merchants |
beneficiaryName | string | Name of the person whom will receive the money. *Required for Guatemala and Peru merchants |
beneficiaryLastName | string | Lastname of the person whom will receive the money. *Required for Ecuador and Peru merchants |
string | email of the person whom will receive the money. *Required for Peru merchants | |
cellphone | string | cellphone without indicative of the person whom will receive the money. *Required for Peru merchants |
Response data
code: Code of the result, "0000" indicates success, any other indicates an error
text: Contains the message associated with the code that was sent.
data: Contains the transaction data (for successful results)
amount: Transaction amount
transactionCost: The cost the user assumes for executing the transaction
currency: Registered currency for the cashout operation
description: Description of the operation
document: Identification number
otp: Generated OTP for the operation (If the SMS parameter is true, this value is not provided)
operation: Operation ID, generated by the commerce/merchant
expire: Expiration date of the operation
payvalidaCode: Operation ID in Payvalida
balance: Available balance for operations
The CURRENCY parameter only accepts USD and the local currency, corresponding to the country where the commerce was registered. If USD is received, the system automatically converts it to the local currency.
All registered operations start with a PENDIENTE (pending) status.
The "expire" field indicates the date on which withdrawals cannot be made.
Last updated