Skip to content

chore: add verify snippet for doc #110

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 6, 2025
Merged

chore: add verify snippet for doc #110

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 21 additions & 34 deletions dist/api/transfers/verify/response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,65 +5,52 @@
"status": true,
"message": "Transfer retrieved",
"data": {
"amount": 20000,
"createdAt": "2024-02-01T08:32:21.000Z",
"amount": 100000,
"createdAt": "2025-08-04T09:59:19.000Z",
"currency": "NGN",
"domain": "test",
"failures": null,
"id": 451930323,
"id": 860670817,
"integration": 463433,
"reason": "Life go better for you",
"reference": "ge-bzrf8u8k2pygxrnqf",
"reason": "Bonus for the week",
"reference": "acv_9ee55786-2323-4760-98e2-6380c9cb3f67",
"source": "balance",
"source_details": null,
"status": "success",
"titan_code": null,
"transfer_code": "TRF_fpmd0l8uta8upow7",
"request": 502643104,
"transfer_code": "TRF_8opchtrhtjlfz90n",
"request": 1068403325,
"transferred_at": null,
"updatedAt": "2024-02-01T08:34:07.000Z",
"updatedAt": "2025-08-04T09:59:19.000Z",
"recipient": {
"active": true,
"createdAt": "2021-10-21T11:08:04.000Z",
"createdAt": "2023-07-11T15:42:27.000Z",
"currency": "NGN",
"description": null,
"description": "",
"domain": "test",
"email": "[email protected]",
"id": 19643784,
"email": null,
"id": 56824902,
"integration": 463433,
"metadata": {
"custom_fields": [
{
"display_name": "Branch Name",
"variable_name": "branchName",
"value": "funny place, Alabama"
},
{
"display_name": "Branch ID",
"variable_name": "branchID",
"value": "123"
}
]
},
"name": "Abbey Baker",
"recipient_code": "RCP_rjs1szi4ax5hoeo",
"metadata": null,
"name": "Jekanmo Padie",
"recipient_code": "RCP_gd9vgag7n5lr5ix",
"type": "nuban",
"updatedAt": "2023-03-29T08:39:39.000Z",
"updatedAt": "2023-07-11T15:42:27.000Z",
"is_deleted": false,
"isDeleted": false,
"details": {
"authorization_code": null,
"account_number": "0123456789",
"account_name": "Abbey Baker",
"bank_code": "058",
"bank_name": "Guaranty Trust Bank"
"account_number": "9876543210",
"account_name": null,
"bank_code": "044",
"bank_name": "Access Bank"
}
},
"session": {
"provider": null,
"id": null
},
"fee_charged": 0,
"fee_charged": 1000,
"fees_breakdown": null,
"gateway_response": null
}
Expand Down
117 changes: 117 additions & 0 deletions dist/doc/transfers/single/verify-transfer.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
const sh = `#!/bin/sh
url="https://api.paystack.co/transfer/verify/{reference}"
authorization="Authorization: Bearer YOUR_SECRET_KEY"

curl "$url" -H "$authorization" -X GET`

const js = `const https = require('https')

const options = {
hostname: 'api.paystack.co',
port: 443,
path: '/transfer/verify/{reference}',
method: 'GET',
headers: {
Authorization: 'Bearer SECRET_KEY'
}
}

https.request(options, res => {
let data = ''

res.on('data', (chunk) => {
data += chunk
});

res.on('end', () => {
console.log(JSON.parse(data))
})
}).on('error', error => {
console.error(error)
})`

const php = `<?php
$curl = curl_init();

curl_setopt_array($curl, array(
CURLOPT_URL => "https://api.paystack.co/transfer/verify/{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 => array(
"Authorization: Bearer SECRET_KEY",
"Cache-Control: no-cache",
),
));

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

curl_close($curl);

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

const json = `{
"status": true,
"message": "Transfer retrieved",
"data": {
"amount": 100000,
"createdAt": "2025-08-04T09:59:19.000Z",
"currency": "NGN",
"domain": "test",
"failures": null,
"id": 860670817,
"integration": 463433,
"reason": "Bonus for the week",
"reference": "acv_9ee55786-2323-4760-98e2-6380c9cb3f67",
"source": "balance",
"source_details": null,
"status": "success",
"titan_code": null,
"transfer_code": "TRF_8opchtrhtjlfz90n",
"request": 1068403325,
"transferred_at": null,
"updatedAt": "2025-08-04T09:59:19.000Z",
"recipient": {
"active": true,
"createdAt": "2023-07-11T15:42:27.000Z",
"currency": "NGN",
"description": "",
"domain": "test",
"email": null,
"id": 56824902,
"integration": 463433,
"metadata": null,
"name": "Jekanmo Padie",
"recipient_code": "RCP_gd9vgag7n5lr5ix",
"type": "nuban",
"updatedAt": "2023-07-11T15:42:27.000Z",
"is_deleted": false,
"isDeleted": false,
"details": {
"authorization_code": null,
"account_number": "9876543210",
"account_name": null,
"bank_code": "044",
"bank_name": "Access Bank"
}
},
"session": {
"provider": null,
"id": null
},
"fee_charged": 1000,
"fees_breakdown": null,
"gateway_response": null
}
}`

export {sh, js, php, json}
55 changes: 21 additions & 34 deletions src/api/transfers/verify/response.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,65 +5,52 @@
"status": true,
"message": "Transfer retrieved",
"data": {
"amount": 20000,
"createdAt": "2024-02-01T08:32:21.000Z",
"amount": 100000,
"createdAt": "2025-08-04T09:59:19.000Z",
"currency": "NGN",
"domain": "test",
"failures": null,
"id": 451930323,
"id": 860670817,
"integration": 463433,
"reason": "Life go better for you",
"reference": "ge-bzrf8u8k2pygxrnqf",
"reason": "Bonus for the week",
"reference": "acv_9ee55786-2323-4760-98e2-6380c9cb3f67",
"source": "balance",
"source_details": null,
"status": "success",
"titan_code": null,
"transfer_code": "TRF_fpmd0l8uta8upow7",
"request": 502643104,
"transfer_code": "TRF_8opchtrhtjlfz90n",
"request": 1068403325,
"transferred_at": null,
"updatedAt": "2024-02-01T08:34:07.000Z",
"updatedAt": "2025-08-04T09:59:19.000Z",
"recipient": {
"active": true,
"createdAt": "2021-10-21T11:08:04.000Z",
"createdAt": "2023-07-11T15:42:27.000Z",
"currency": "NGN",
"description": null,
"description": "",
"domain": "test",
"email": "[email protected]",
"id": 19643784,
"email": null,
"id": 56824902,
"integration": 463433,
"metadata": {
"custom_fields": [
{
"display_name": "Branch Name",
"variable_name": "branchName",
"value": "funny place, Alabama"
},
{
"display_name": "Branch ID",
"variable_name": "branchID",
"value": "123"
}
]
},
"name": "Abbey Baker",
"recipient_code": "RCP_rjs1szi4ax5hoeo",
"metadata": null,
"name": "Jekanmo Padie",
"recipient_code": "RCP_gd9vgag7n5lr5ix",
"type": "nuban",
"updatedAt": "2023-03-29T08:39:39.000Z",
"updatedAt": "2023-07-11T15:42:27.000Z",
"is_deleted": false,
"isDeleted": false,
"details": {
"authorization_code": null,
"account_number": "0123456789",
"account_name": "Abbey Baker",
"bank_code": "058",
"bank_name": "Guaranty Trust Bank"
"account_number": "9876543210",
"account_name": null,
"bank_code": "044",
"bank_name": "Access Bank"
}
},
"session": {
"provider": null,
"id": null
},
"fee_charged": 0,
"fee_charged": 1000,
"fees_breakdown": null,
"gateway_response": null
}
Expand Down
5 changes: 5 additions & 0 deletions src/doc/transfers/single/verify-transfer/config.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
languages:
- sh
- js
- php
- json
25 changes: 25 additions & 0 deletions src/doc/transfers/single/verify-transfer/index.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
const https = require('https')

const options = {
hostname: 'api.paystack.co',
port: 443,
path: '/transfer/verify/{reference}',
method: 'GET',
headers: {
Authorization: 'Bearer SECRET_KEY'
}
}

https.request(options, res => {
let data = ''

res.on('data', (chunk) => {
data += chunk
});

res.on('end', () => {
console.log(JSON.parse(data))
})
}).on('error', error => {
console.error(error)
})
54 changes: 54 additions & 0 deletions src/doc/transfers/single/verify-transfer/index.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
{
"status": true,
"message": "Transfer retrieved",
"data": {
"amount": 100000,
"createdAt": "2025-08-04T09:59:19.000Z",
"currency": "NGN",
"domain": "test",
"failures": null,
"id": 860670817,
"integration": 463433,
"reason": "Bonus for the week",
"reference": "acv_9ee55786-2323-4760-98e2-6380c9cb3f67",
"source": "balance",
"source_details": null,
"status": "success",
"titan_code": null,
"transfer_code": "TRF_8opchtrhtjlfz90n",
"request": 1068403325,
"transferred_at": null,
"updatedAt": "2025-08-04T09:59:19.000Z",
"recipient": {
"active": true,
"createdAt": "2023-07-11T15:42:27.000Z",
"currency": "NGN",
"description": "",
"domain": "test",
"email": null,
"id": 56824902,
"integration": 463433,
"metadata": null,
"name": "Jekanmo Padie",
"recipient_code": "RCP_gd9vgag7n5lr5ix",
"type": "nuban",
"updatedAt": "2023-07-11T15:42:27.000Z",
"is_deleted": false,
"isDeleted": false,
"details": {
"authorization_code": null,
"account_number": "9876543210",
"account_name": null,
"bank_code": "044",
"bank_name": "Access Bank"
}
},
"session": {
"provider": null,
"id": null
},
"fee_charged": 1000,
"fees_breakdown": null,
"gateway_response": null
}
}
Loading