Operation

Get Operation

GET https::/api.payvalida.com/cashout/v1/operation/{merchant}/{operation}

URL Sandbox: https://api-test.payvalida.com/v1/operation/{merchant}/{operation}

This method allows to retrieve information of a cashout operation, showing the most relevant data of it.

Path Parameters

Name	Type	Description
merchant*	string	Commerce/merchant that owns the operation (Max 30 characters)
operation*	string	Operation ID, generated by the commerce/merchant (Max 40 characters)

Query Parameters

Name	Type	Description
checksum*	string	Checksum encoded in SHA512 (merchant + operation + document + FIXED_HASH) (512 characters)
document*	number	ID or reference associated with the operation (Max 20 characters)

200 Returns a Json following this structure:

{  
   "code":"0000",
   "text":"OK",
   "data":{
      "amount":"45000.0",
      "transactionCost":"2000.0",
      "currency":"COP",
      "description":"Retiro dividendos",
      "document":"986157352",
      "sms":"false",
      "cellphone":"3015555555",
      "operation":"15249",
      "expire":"01122019",
      "update":"01122019",
      "status":"APROBADA"
   }
}

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's data (empty if an error occurs)

• 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

• sms: Indicates if the OTP was sent to the end user via SMS

• cellphone: Phone number where the OTP will be sent

• operation: Operation ID, generated by the commerce

• expire: Expiration date of the operation

• update: Las modified date of the operation

• status: Operation status

Possible Statuses

• Aprobada (approved): Cashout was processed successfully

• Vencida (expired): Cashout wasn't processed before due date

• Cancelada (cancelled): The operation was cancelled by the commerce/merchant

• Anulada (nullified): The operation was nullified by Payvalida

• Pendiente (pending): The operation is waiting for the completion of cashout