Multiple Operations

Get Multiple Operations

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

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

This method retrieves information of various cashout operations, the request can be filtered by status, document and update date.

Path Parameters

Name	Type	Description
merchant	string	Commerce/merchant that owns the operation (30 characters)

Query Parameters

Name	Type	Description
checksum	string	Checksum encoded in SHA512 (merchant+start+end+FIXED_HASH)(512 characters)
status	string	Transaction status (default = 0)(Max 12 characters)
document	number	Filter by ID (default ALL) (Max 20 characters)
start	number	Start date for the search ( YYYYMMDD format, default TODAY) (8 characters)
end	number	End date for the search ( YYYYMMDD date, default TODAY) (8 characters)
page	number	Page number (default >0) (Max 4 characters)
limit	number	Amount of elements in the response (default 23, 10 <= limit <= 100) (Max 4 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",
},
{
      "amount": "35000.0",
      "transactionCost": "1500.0",
      "currency": "COP",
      "description": "Retiro dividendos",
      "document": "5488352",
      "sms": "false",
      "cellphone": "3015555555",
      "operation": "BFT409",
      "expire": "01122019",
      "update": "01122019",
      "status": "PENDIENTE",
    }
  ]
}

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.

first: Contains the information needed to obtain the elements of the first page

previous: Contains the information needed to obtain the elements of the previous page

next: Contains the information needed to obtain the elements of the next page

end: Contains the information needed to obtain the elements of the last page

data: Contains an array with the data of the transactions (empty if an error occurs or if there's no elements between the specified dates)

• 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