Cancelar Pagamento

DICA (TIP)

Para que os usuários cancelem manualmente o pagamento ou para que os comerciantes cancelem o pagamento.

Endereço da interface (Interface address)

POST https://api.tokenpay.me/v1/payanother/close

Interface parameters

Nome

Localização

Tipo

Obrigatório

Descrição

app_id

header

string

Sim

ID do aplicativo, valor de exemplo: 8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd

mch_id

body

string

Sim

ID do comerciante, valor de exemplo: 12345678

payout_id

body

string

Não

Pedido da plataforma, valor de exemplo: 2a1cfa6568xxxxxxxx3050957024c559

Exemplo de parâmetros (Parameters example)

{
  "app_id": "8e4b8c2e7cxxxxxxxx1a1cbd3d59e0bd",
  "mch_id": "12345678",
  "payout_id": "2a1cfa6568xxxxxxxx3050957024c559"
}

Interface return

Nome

Tipo

Descrição

code

integer

Código de status

nenhum

msg

string

Descrição do status

nenhum

request_id

string

ID da requisição

nenhum

Exemplo de retorno (Return example)

{
  "code": 0,
  "msg": "success",
  "request_id": "f23ade4a-e5ca-48f4-a4bb-59114ac360ba",
}

Exemplo de código (Example code)

curl --location --request POST 'https://api.tokenpay.me/v1/payout/close' \
--header 'Authorization: <Authorization>' \
--header 'User-Agent: tokenpay API (https://tokenpay.me)' \
--header 'Content-Type: application/json' \
--data-raw '<body data here>'

package main

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

func main() {

   url := "https://api.tokenpay.me/v1/payout/close"
   method := "POST"

   payload := strings.NewReader(`<body data here>`)

   client := &http.Client {
   }
   req, err := http.NewRequest(method, url, payload)

   if err != nil {
      fmt.Println(err)
      return
   }
   req.Header.Add("Authorization", "<Authorization>")
   req.Header.Add("User-Agent", "tokenpay API (https://tokenpay.me)")
   req.Header.Add("Content-Type", "application/json")

   res, err := client.Do(req)
   if err != nil {
      fmt.Println(err)
      return
   }
   defer res.Body.Close()

   body, err := ioutil.ReadAll(res.Body)
   if err != nil {
      fmt.Println(err)
      return
   }
   fmt.Println(string(body))
}

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
   CURLOPT_URL => 'https://api.tokenpay.me/v1/payout/close',
   CURLOPT_RETURNTRANSFER => true,
   CURLOPT_ENCODING => '',
   CURLOPT_MAXREDIRS => 10,
   CURLOPT_TIMEOUT => 0,
   CURLOPT_FOLLOWLOCATION => true,
   CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
   CURLOPT_CUSTOMREQUEST => 'POST',
   CURLOPT_POSTFIELDS =>'<body data here>',
   CURLOPT_HTTPHEADER => array(
      'Authorization: <Authorization>',
      'User-Agent: tokenpay API (https://tokenpay.me)',
      'Content-Type: application/json'
   ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import http.client
import json

conn = http.client.HTTPSConnection("https://api.tokenpay.me")
payload = "<body data here>"
headers = {
   'Authorization': '<Authorization>',
   'User-Agent': 'tokenpay API (https://tokenpay.me)',
   'Content-Type': 'application/json'
}
conn.request("POST", "/v1/payout/close", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))

OkHttpClient client = new OkHttpClient().newBuilder()
   .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "<body data here>");
Request request = new Request.Builder()
   .url("https://api.tokenpay.me/v1/payout/close")
   .method("POST", body)
   .addHeader("Authorization", "<Authorization>")
   .addHeader("User-Agent", "tokenpay API (https://tokenpay.me)")
   .addHeader("Content-Type", "application/json")
   .build();
Response response = client.newCall(request).execute();

AnteriorNotificação de callback

SeguinteCódigo de erro

Última atualização há 25 dias