Easy Cashout Status Endpoint

Learn how to check the status of a cashout requests with our Easy Cashout API

Easy Cashout Status Endpoint

GET https://payout-api-stg.directa24.com/v1/payments/{request_id}

Use this endpoint to check wether a cashout was created by the customer and its status

Path Parameters

Name	Type	Description
request_id	string	This is the ID returned along with the cashout_url link

200 Status retrieved successfully

{
    "data": {
        "amount": 250,
        "bank_name": "Banco Santander",
        "currency": "USD",
        "date_created": "2020-07-26T04:28:28Z",
        "external_id": "45343556242333",
        "last_status_change": "2020-07-26T04:28:51Z",
        "request_id": "9934005565ac4e098de983d1ff450231",
        "status": "PENDING",
        "user_document": "**********5-48"
    }
}

404 The request_id specified couldn

{
    "error": "not_found",
    "message": "The requested resource doesn't exist"
}

Easy Cashout Status Request

Request Example

Once you have created an Easy Cashout request, the request won't be send for processing until the customer opens the link and fill in all their details. To know when the customer completed their details, you will need to check the status of it after some minutes. That can be done by doing a GET of the following URL with the ID obtained from the cashout_url.

If the Easy Cashout Creation returned the following URL:

"cashout_url": "https://payout.directa24.com/payout/9934005565ac4e098de983d1ff450231",

Then the ID after /payout/ will be used to identify the cashout with the Status endpoint: 9934005565ac4e098de983d1ff450231

JSON

// URL
GET: https://payout-api-stg.directa24.com/v1/payments/9934005565ac4e098de983d1ff450231

cURL

curl --location --request GET 'https://payout-api-stg.directa24.com/v1/payments/9934005565ac4e098de983d1ff450231'

Java

import java.io.*;
import okhttp3.*;
public class main {
  public static void main(String []args) throws IOException{
    OkHttpClient client = new OkHttpClient().newBuilder()
      .build();
    Request request = new Request.Builder()
      .url("https://payout-api-stg.directa24.com/v1/payments/9934005565ac4e098de983d1ff450231")
      .method("GET", null)
      .build();
    Response response = client.newCall(request).execute();
    System.out.println(response.body().string());
  }
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://payout-api-stg.directa24.com/v1/payments/9934005565ac4e098de983d1ff450231",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET"
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

C#

using System;
using RestSharp;
namespace HelloWorldApplication {
    class HelloWorld {
        static void Main(string[] args) {
            var client = new RestClient("https://payout-api-stg.directa24.com/v1/payments/9934005565ac4e098de983d1ff450231");
            client.Timeout = -1;
            var request = new RestRequest(Method.GET);
            IRestResponse response = client.Execute(request);
            Console.WriteLine(response.Content);
        }
    }
}

Python

import http.client
import mimetypes
conn = http.client.HTTPSConnection("payout-api-stg.directa24.com")
payload = ''
headers = {}
conn.request("GET", "/v1/payments/9934005565ac4e098de983d1ff450231", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

Response: Success

Response Example

{
    "data": {
        "amount": 250,
        "bank_name": "Banco Santander",
        "currency": "USD",
        "date_created": "2020-07-26T04:28:28Z",
        "external_id": "45343556242333",
        "last_status_change": "2020-07-26T04:28:51Z",
        "request_id": "9934005565ac4e098de983d1ff450231",
        "status": "PENDING",
        "user_document": "**********5-48"
    }
}

Response Fields

Field name	Format	Description
data	object[]	Object containing the elements of the response
data.amount	Number	Amount of the cashout. It is the same you sent
data.bank_name	String	Name of the bank the customer chose
data.currency	String	Currency of the amount. It is the same you sent
data.date_created	String	Date and Time in which the customer completed the cashout
data.external_id	String	External ID of the transaction. It is the same you sent
data.last_status_change	String	Last Date and Time in which the cashout changes its status
data.request_id	String	Cashout request ID
data.status	String	Status of the transaction: [PENDING, DELIVERED, COMPLETED, REJECTED, ON_HOLD, CANCELLED]
data.user_document	String	Masked document ID of the customer

Response: Error

Response Example

// Internal Error
{
    "error": "internal_error",
    "message": "An internal system error has occurred. Please, try again later"
}

// Cashout not found or not confirmed by the customer
{
    "error": "not_found",
    "message": "The requested resource doesn't exist"
}

Response Fields

Field name	Format	Description
error	String	Field containing the error type
message	String	Field containing the description of the error

Status HTTP Codes

Code	Description
200	Status of the cashout successfully retrieved
404	The cashout couldn't be locate with the ID provided
5XX	Internal error