Get payin status by reference or id

GET /v1/payins/{reference}

Get payin status by reference or id

cURL

curl --request GET \
  --url http://localhost/v1/payins/{reference} \
  --header 'Authorization: Bearer <token>'

import requests

url = "http://localhost/v1/payins/{reference}"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('http://localhost/v1/payins/{reference}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "http://localhost/v1/payins/{reference}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost/v1/payins/{reference}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost/v1/payins/{reference}")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost/v1/payins/{reference}")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "ok": true,
  "data": {
    "reference": "<string>",
    "amount": "<string>",
    "checkoutUrl": "<string>",
    "expiresAt": "<string>",
    "initiatedAt": "<string>",
    "settledAt": "<string>"
  }
}

{
  "ok": false,
  "error": {
    "code": "<string>",
    "message": "<string>",
    "details": "<unknown>"
  }
}

Authorizations

bearerAuthcookieAuth

Authorization · string · header · required

JWT utilisateur ou clé API kp_<env>_xxx

Path Parameters

reference · string · required

Response

200

application/json

Default Response

ok · enum<boolean> · required

Available options: true

data · object · required

Show child attributes