curl --request GET \
--url https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id} \
--header 'Authorization: Bearer <token>'const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}"
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))
}{
"object": "payin",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stan": "<string>",
"method": "<string>",
"target_currency": "<string>",
"rail_currency": "<string>",
"amount": 123,
"rail_amount": 123,
"target_amount": 123,
"scale": 123,
"status": "<string>",
"checkout_url": "<string>",
"redirect_url": "<string>",
"source_kind": "<string>",
"collection_mode": "<string>",
"network": "<string>",
"instructions": {},
"failure_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"livemode": true,
"environment": "live"
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}{
"error": {
"type": "permission_error",
"code": "api_disabled",
"message": "Public API access is disabled for this workspace."
}
}Get Payin
curl --request GET \
--url https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id} \
--header 'Authorization: Bearer <token>'const url = 'https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch(url, options)
.then(res => res.json())
.then(json => console.log(json))
.catch(err => console.error(err));import requests
url = "https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://20b9-41-90-209-232.ngrok-free.app/v1/payins/{id}"
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))
}{
"object": "payin",
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"stan": "<string>",
"method": "<string>",
"target_currency": "<string>",
"rail_currency": "<string>",
"amount": 123,
"rail_amount": 123,
"target_amount": 123,
"scale": 123,
"status": "<string>",
"checkout_url": "<string>",
"redirect_url": "<string>",
"source_kind": "<string>",
"collection_mode": "<string>",
"network": "<string>",
"instructions": {},
"failure_reason": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"livemode": true,
"environment": "live"
}{
"error": {
"type": "authentication_error",
"code": "invalid_api_key",
"message": "Invalid API key provided."
}
}{
"error": {
"type": "permission_error",
"code": "api_disabled",
"message": "Public API access is disabled for this workspace."
}
}Authorizations
Secret API key from Settings → Developers → API keys.
Example: Authorization: Bearer sk_test_…
Path Parameters
Payin attempt id.
Response
Payin
Object type discriminator.
payin Payin attempt id.
System trace / reference.
Funding method.
Book currency to credit.
Currency on the payment rail when different.
Requested amount in target (or primary) minor units.
Amount on the rail in rail minor units.
Expected credit to the target book in minor units.
Decimal places for target_currency.
Lifecycle status (pending, processing, completed, failed, …).
Hosted checkout URL when the method requires a redirect.
Return URL you supplied.
Origin kind from prepare.
Prepare mode (bank_details, crypto_address, …).
Crypto network when applicable.
Receive instructions for the payer (account number, bank name,
wallet address, etc.). Shape depends on collection_mode.
Failure message when status is failed.
Creation time (UTC).
Last status change (UTC).
When the deposit completed, if successful.
true when created with a live key.
Environment of the creating API key.
live, sandbox