{"openapi":"3.0.0","info":{"title":"Payments API V2","description":"# Introduction\nPayments API v2 enables payers to:\n- Create and manage recipients at an aggregator or payer level\n- Create and manage destination payment accounts at an aggregator or payer level\n- Create and manage payments for Portal acceptance\n- Create payout transactions for immediate disbursement\n\n# Idempotent Requests\nThe API supports **Idempotency** for safely retrying requests without performing the same operation twice for **Create Payment** and **Create Transaction** endpoints.  Add the `Idempotency-Key: <key>` header to the request using a unique value as the key.  Idempotency Keys are honored for 24 hours and only for **20x** and **400** responses.  If the supplied ~Idempotency-Key` value matches an existing request the following HTTP Status codes may be returned.\n- **102 PROCESSING** : We are still processing the request\n- **409 CONFLICT** : We have previously processing the request and return the original response body payload.\n\n# HTTP Status Codes\n| HTTP Status Code | Description |\n| --- | ---- |\n| 102 | Idempotent request is current processing |\n| 200 | Request processed |\n| 201 | Request processed and entity created |\n| 400 | Bad request due to invalid or missing parameters |\n| 401 | Not Authenticated |\n| 403 | Not Authorized |\n| 404 | Resource or entity not found |\n| 409 | Idempotent request conflict |\n| 429 | Too many requests in a given amount of time |\n| 500 | Unexpected error while processing the request |\n| 503 | Service unavailable or timeout |\n\n# Error Response\nRequests resulting in an error response will contain an HTTP status code, error message, and an error code for non-authentication related errors.\n\n** Authentication Error example **\n```\n{\n    \"http_status\": 401,\n    \"error_message\": \"401 UNAUTHORIZED\"\n}\n```\n### Authorization Error example\n```\n{\n    \"http_status\": 403,\n    \"error_message\": \"403 FORBIDDEN\"\n}\n```\n### Bad Request example\n```\n{\n    \"http_status\": 400,\n    \"error_code\": \"ERR_INVALID_RECIPIENT_ID\",\n    \"error_message\": \"Invalid recipient ID\"\n}\n```\n\n# Error Codes\nListed in alphabetical order\n\n| Error Code | Error Message |\n| --- | --- |\n| ERR_ACCOUNT_LIMIT_EXCEEDED | Activity limit exceeded |\n| ERR_ACCOUNT_PROVIDER_NOT_ENABLED | Payer not enabled for Account Provider |\n| ERR_ACCOUNT_PROVIDER_MISMATCH | Account invalid for provider |\n| ERR_CARD_INELIGIBLE | Card ineligible |\n| ERR_CLIENT_ACCESS_PAYER | Client does not have access to payer |\n| ERR_CREDIT_CARD_NOT_SUPPORTED | Credit cards not supported |\n| ERR_EMAIL_IN_USE | Recipient email is assigned to another profile |\n| ERR_INTERNAL_SERVER_ERROR | Internal server error |\n| ERR_INVALID_ACCOUNT_ID | Invalid account ID |\n| ERR_INVALID_CARD_DETAILS | Invalid card details |\n| ERR_INVALID_COUNTRY | Invalid Country |\n| ERR_INVALID_CURRENCY_CODE | Invalid Currency Code |\n| ERR_INVALID_EMAIL | Invalid email |\n| ERR_INVALID_NAME | Invalid or missing name fields |\n| ERR_INVALID_PARAMETER | Missing or invalid request parameters |\n| ERR_INVALID_PAYMENT_ID | Invalid payment ID |\n| ERR_INVALID_PAYER_ID | Invalid payer ID |\n| ERR_INVALID_PAYMENT_REFERENCE_ID | Payment reference ID not found |\n| ERR_INVALID_PAYOUT_METHOD_FOR_ACCOUNT | Invalid payout method for account |\n| ERR_INVALID_RECIPIENT_EMAIL | Invalid recipient email |\n| ERR_INVALID_RECIPIENT_ID | Invalid recipient ID |\n| ERR_INVALID_RECIPIENT_REFERENCE_ID | Recipient reference ID not found |\n| ERR_INVALID_ROUTING_NUMBER | Invalid Routing Number |\n| ERR_INVALID_STATE | Invalid State |\n| ERR_INVALID_TRANSACTION_ID | Invalid transaction ID |\n| ERR_INVALID_TRANSACTION_REFERENCE_ID | Transaction reference ID not found |\n| ERR_MISSING_RECIPIENT | Missing recipient ID or email |\n| ERR_OCT_DECLINE | (Error specific to decline reason) | \n| ERR_OFAC_LIST_MATCH | Cancelled due to OFAC list match |\n| ERR_PAYMENT_STATUS_IMMUTABLE | Payment in immutable status |\n| ERR_PAYMENT_STATUS_NOT_APPLICABLE | Payment status cannot be applied |\n| ERR_PAYOUT_METHOD_NOT_AVAILABLE | Payout method not available |\n| ERR_RECIPIENT_NOT_FOUND | Recipient email not found |\n| ERR_RETRIEVING_CARD_DETAILS | Error determining card eligibility |\n| ERR_TRANSACTION_FAILURE | (Error specific to transaction failure) |\n| ERR_VERIFICATION_NOT_ENABLED | Payer not enabled for TIN Verification |","contact":{},"version":"2"},"servers":[{"url":"http://example.com","variables":{}}],"paths":{"/oauth2/token":{"post":{"tags":["Authentication"],"summary":"Auth Token","operationId":"AuthToken","parameters":[],"requestBody":{"content":{"application/x-www-form-urlencoded":{"encoding":{},"schema":{"required":["grant_type"],"type":"object","properties":{"grant_type":{"type":"string","example":"client_credentials"}}}}},"required":false},"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payers/accounts":{"get":{"tags":["Payers"],"summary":"Get Payer Bank Accounts","description":"Retrieves an array of connected accounts for a Payer.  If we are unable to pull account information an `error_message` field will be present in the account response.","operationId":"GetPayerBankAccounts","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=NmZkYjcwNDYtMDMyNC00YjFmLWI2MTMtM2E4NmE0NTdlODdi; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=NmZkYjcwNDYtMDMyNC00YjFmLWI2MTMtM2E4NmE0NTdlODdi; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 15:35:27 GMT"},"example":"Mon, 11 Oct 2021 15:35:27 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetPayerBankAccount"},"description":"","example":[{"account_bank":"MVB BANK, INC.","routing_number":"051504597","account_number":"123456789","balance":34000,"balance_real_time":true,"payout_methods":["INSTANT_DEPOSIT","ACH_STANDARD"]}]},"example":[{"account_bank":"MVB BANK, INC.","routing_number":"051504597","account_number":"123456789","balance":34000,"balance_real_time":true,"payout_methods":["INSTANT_DEPOSIT","ACH_STANDARD"]}]}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients":{"post":{"tags":["Recipients"],"summary":"Create Recipient","operationId":"CreateRecipient","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRecipientRequest"},"example":{"email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith","reference_id":"payee-123456"}}},"required":true},"responses":{"201":{"description":"Created","headers":{"Location":{"content":{"text/plain":{"schema":{"type":"string","example":"http://localhost:8080/payer-api/v2/PAXI-q3MTJS-afWzgMp6WzPQ/recipients/REPg25ZBRVQ2qBEqbF_2HItg=="},"example":"http://localhost:8080/payer-api/v2/PAXI-q3MTJS-afWzgMp6WzPQ/recipients/REPg25ZBRVQ2qBEqbF_2HItg=="}}},"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=ZTRhZTQ5MTYtNjFjYi00MzI3LWEzN2UtZjQ5Zjg2OWQ5NjNj; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=ZTRhZTQ5MTYtNjFjYi00MzI3LWEzN2UtZjQ5Zjg2OWQ5NjNj; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:33:40 GMT"},"example":"Mon, 11 Oct 2021 21:33:40 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateRecipient"},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients/{recipient_id}":{"get":{"tags":["Recipients"],"summary":"Get Recipient by ID","operationId":"GetRecipientbyID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=YWQxN2ZmYTUtNTg2MS00ZDkwLWFkY2UtZTI2YzQ1YjY3MmVm; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=YWQxN2ZmYTUtNTg2MS00ZDkwLWFkY2UtZTI2YzQ1YjY3MmVm; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:35:34 GMT"},"example":"Mon, 11 Oct 2021 21:35:34 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRecipientbyID"},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients/reference/{recipient_reference_id}":{"get":{"tags":["Recipients"],"summary":"Get Recipient by Reference ID","operationId":"GetRecipientbyReferenceID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_reference_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=YTY1MzIyMzAtZWZlNy00OTY0LWI1ZGItYTY3ODE0ZmI3MmE0; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=YTY1MzIyMzAtZWZlNy00OTY0LWI1ZGItYTY3ODE0ZmI3MmE0; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:35:54 GMT"},"example":"Mon, 11 Oct 2021 21:35:54 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetRecipientbyReferenceID"},"description":"","example":[{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}]},"example":[{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}]}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients/email/{recipient_email}":{"get":{"tags":["Recipients"],"summary":"Get Recipient by Email","operationId":"GetRecipientbyEmail","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_email","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"Content-Disposition":{"content":{"text/plain":{"schema":{"type":"string","example":"inline;filename=f.txt"},"example":"inline;filename=f.txt"}}},"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=MWU0OWFlOTQtYzE2Zi00NWE3LTgyYmItNTc4Zjk0NDk2YWUz; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=MWU0OWFlOTQtYzE2Zi00NWE3LTgyYmItNTc4Zjk0NDk2YWUz; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:36:33 GMT"},"example":"Mon, 11 Oct 2021 21:36:33 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRecipientbyEmail"},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients/{recipient_id}/emails":{"post":{"tags":["Recipient Emails"],"summary":"Add Recipient Email","operationId":"AddRecipientEmail","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddRecipientEmailRequest"},"example":{"email":"payee-123456@mailinator.com","primary":false}}},"required":true},"responses":{"200":{"description":"OK","headers":{"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=ZmJkYTY2MDktYTJkZC00ZWRhLWJhYmEtMGRjZjk2YTBmNTAz; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=ZmJkYTY2MDktYTJkZC00ZWRhLWJhYmEtMGRjZjk2YTBmNTAz; Path=/; HttpOnly; SameSite=Lax"}}},"Content-Length":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:53:29 GMT"},"example":"Mon, 11 Oct 2021 21:53:29 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{}}},"deprecated":false},"get":{"tags":["Recipient Emails"],"summary":"Get Recipient Emails","operationId":"GetRecipientEmails","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"OK","headers":{"X-Content-Type-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"nosniff"},"example":"nosniff"}}},"X-XSS-Protection":{"content":{"text/plain":{"schema":{"type":"string","example":"1; mode=block"},"example":"1; mode=block"}}},"Cache-Control":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache, no-store, max-age=0, must-revalidate"},"example":"no-cache, no-store, max-age=0, must-revalidate"}}},"Pragma":{"content":{"text/plain":{"schema":{"type":"string","example":"no-cache"},"example":"no-cache"}}},"Expires":{"content":{"text/plain":{"schema":{"type":"string","example":"0"},"example":"0"}}},"X-Frame-Options":{"content":{"text/plain":{"schema":{"type":"string","example":"DENY"},"example":"DENY"}}},"Set-Cookie":{"content":{"text/plain":{"schema":{"type":"string","example":"SESSION=OWQ2MWZlZWQtZjQwYS00NzFhLTk3NmYtNjg3MWE3ZmYxZjFi; Path=/; HttpOnly; SameSite=Lax"},"example":"SESSION=OWQ2MWZlZWQtZjQwYS00NzFhLTk3NmYtNjg3MWE3ZmYxZjFi; Path=/; HttpOnly; SameSite=Lax"}}},"Transfer-Encoding":{"content":{"text/plain":{"schema":{"type":"string","example":"chunked"},"example":"chunked"}}},"Date":{"content":{"text/plain":{"schema":{"type":"string","example":"Mon, 11 Oct 2021 21:53:50 GMT"},"example":"Mon, 11 Oct 2021 21:53:50 GMT"}}},"Keep-Alive":{"content":{"text/plain":{"schema":{"type":"string","example":"timeout=60"},"example":"timeout=60"}}},"Connection":{"content":{"text/plain":{"schema":{"type":"string","example":"keep-alive"},"example":"keep-alive"}}}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/GetRecipientEmail"},"description":"","example":[{"email":"payee-123456@mailpoof.com","primary":true,"invalid":false},{"email":"payee-123456@mailinator.com","primary":false,"invalid":false}]},"example":[{"email":"payee-123456@mailpoof.com","primary":true,"invalid":false},{"email":"payee-123456@mailinator.com","primary":false,"invalid":false}]}}}},"deprecated":false}},"/api/v2/{payer_id}/recipients/{recipient_id}/verification":{"post":{"tags":["Recipient Verification"],"summary":"Verify Recipient TIN","operationId":"VerifyRecipientTIN","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyRecipientTINRequest"},"example":{"tin":"123456789","address":{"address_1":"134 N 4th St","city":"Brooklyn","state":"NY","zip":"11249"},"legal_entity_type":"INDIVIDUAL"}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"get":{"tags":["Recipient Verification"],"summary":"Get Recipient TIN Verification","operationId":"GetRecipientTINVerification","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/cards":{"post":{"tags":["Payment Accounts - Card"],"summary":"Create Card Account","operationId":"CreateCardAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCardAccountRequest"},"example":{"card_number":"4515300011000001","exp_date":"2030-01"}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/payer-api/v2/{payer_id}/accounts/{recipient_id}/cards/{account_id}":{"get":{"tags":["Payment Accounts - Card"],"summary":"Get Card Account","operationId":"GetCardAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"delete":{"tags":["Payment Accounts - Card"],"summary":"Delete Card Account","operationId":"DeleteCardAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/payer-api/v2/{payer_id}/accounts/{recipient_id}/cards":{"get":{"tags":["Payment Accounts - Card"],"summary":"Get Card Accounts","operationId":"GetCardAccounts","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/banks":{"post":{"tags":["Payment Accounts - Bank"],"summary":"Create Bank Account","operationId":"CreateBankAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBankAccountRequest"},"example":{"account_number":"123456789","routing_number":"051504597","account_type":"CHECKING"}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"get":{"tags":["Payment Accounts - Bank"],"summary":"Get Bank Accounts","operationId":"GetBankAccounts","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/banks/{account_id}":{"get":{"tags":["Payment Accounts - Bank"],"summary":"Get Bank Account","operationId":"GetBankAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"delete":{"tags":["Payment Accounts - Bank"],"summary":"Delete Bank Account","operationId":"DeleteBankAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/paypal":{"post":{"tags":["Payment Accounts - PayPal"],"summary":"Create PayPal Account","operationId":"CreatePayPalAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePayPalAccountRequest"},"example":{"email":"email@domain.com"}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"get":{"tags":["Payment Accounts - PayPal"],"summary":"Get PayPal Accounts","operationId":"GetPayPalAccounts","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/paypal/{account_id}":{"get":{"tags":["Payment Accounts - PayPal"],"summary":"Get PayPal Account","operationId":"GetPayPalAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/accounts/{recipient_id}/paypal/{account_di}":{"delete":{"tags":["Payment Accounts - PayPal"],"summary":"Delete PayPal Account","operationId":"DeletePayPalAccount","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"recipient_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"account_di","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payments":{"post":{"tags":["Payments"],"summary":"Create Payment","operationId":"CreatePayment","parameters":[{"name":"Idempotency-Key","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","example":"{{$guid}}"}},{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentRequest"},"example":{"recipient_id":"{{recipient_id}}","amount":25}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payments/{payment_id}":{"patch":{"tags":["Payments"],"summary":"Update Payment","operationId":"UpdatePayment","parameters":[{"name":"api-gateway-request-id","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","example":"abc125"}},{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentRequest"},"example":{"status":"CANCELLED"}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false},"get":{"tags":["Payments"],"summary":"Get Payment by ID","operationId":"GetPaymentbyID","parameters":[{"name":"api-gateway-request-id","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","example":"abc124"}},{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payments/reference/{payment_reference_id}":{"get":{"tags":["Payments"],"summary":"Get Payment by Reference ID","operationId":"GetPaymentbyReferenceID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"payment_reference_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payments/{payment_id}/transactions":{"get":{"tags":["Payments"],"summary":"Get Transactions by Payment ID","operationId":"GetTransactionsbyPaymentID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"payment_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/payments/reference/{payment_reference_id}/transactions":{"get":{"tags":["Payments"],"summary":"Get Transactions by Payment Reference ID","operationId":"GetTransactionsbyPaymentReferenceID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"payment_reference_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/transactions":{"post":{"tags":["Transactions"],"summary":"Create Transaction","operationId":"CreateTransaction","parameters":[{"name":"Idempotency-Key","in":"header","description":"","required":true,"style":"simple","schema":{"type":"string","example":"{{$guid}}"}},{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"requestBody":{"description":"","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTransactionRequest"},"example":{"recipient_id":"{{recipient_id}}","account_id":"{{account_id}}","method":"ACH_SAME_DAY","type":"CREDIT","amount":10}}},"required":true},"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/transactions/{transaction_id}":{"get":{"tags":["Transactions"],"summary":"Get Transaction by ID","operationId":"GetTransactionbyID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"transaction_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}},"/api/v2/{payer_id}/transactions/reference/{transaction_reference_id}":{"get":{"tags":["Transactions"],"summary":"Get Transaction by Reference ID","operationId":"GetTransactionbyReferenceID","parameters":[{"name":"payer_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}},{"name":"transaction_reference_id","in":"path","description":"","required":true,"style":"simple","schema":{"type":"string"}}],"responses":{"200":{"description":"","headers":{}}},"deprecated":false}}},"components":{"schemas":{"GetPayerBankAccount":{"title":"GetPayerBankAccount","required":["account_bank","routing_number","account_number","balance","balance_real_time","payout_methods"],"type":"object","properties":{"account_bank":{"type":"string"},"routing_number":{"type":"string"},"account_number":{"type":"string"},"balance":{"type":"number"},"balance_real_time":{"type":"boolean"},"payout_methods":{"type":"array","items":{"type":"string"},"description":""}},"example":{"account_bank":"MVB BANK, INC.","routing_number":"051504597","account_number":"123456789","balance":34000,"balance_real_time":true,"payout_methods":["INSTANT_DEPOSIT","ACH_STANDARD"]}},"CreateRecipientRequest":{"title":"CreateRecipientRequest","required":["email","first_name","last_name","reference_id"],"type":"object","properties":{"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"},"reference_id":{"type":"string"}},"example":{"email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith","reference_id":"payee-123456"}},"CreateRecipient":{"title":"CreateRecipient","required":["recipient_id","reference_id","email","first_name","last_name"],"type":"object","properties":{"recipient_id":{"type":"string"},"reference_id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}},"GetRecipientbyID":{"title":"GetRecipientbyID","required":["recipient_id","reference_id","email","first_name","last_name"],"type":"object","properties":{"recipient_id":{"type":"string"},"reference_id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}},"GetRecipientbyReferenceID":{"title":"GetRecipientbyReferenceID","required":["recipient_id","reference_id","email","first_name","last_name"],"type":"object","properties":{"recipient_id":{"type":"string"},"reference_id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}},"GetRecipientbyEmail":{"title":"GetRecipientbyEmail","required":["recipient_id","reference_id","email","first_name","last_name"],"type":"object","properties":{"recipient_id":{"type":"string"},"reference_id":{"type":"string"},"email":{"type":"string"},"first_name":{"type":"string"},"last_name":{"type":"string"}},"example":{"recipient_id":"REPg25ZBRVQ2qBEqbF_2HItg==","reference_id":"payee-123456","email":"payee-123456@mailpoof.com","first_name":"James","last_name":"Smith"}},"AddRecipientEmailRequest":{"title":"AddRecipientEmailRequest","required":["email","primary"],"type":"object","properties":{"email":{"type":"string"},"primary":{"type":"boolean"}},"example":{"email":"payee-123456@mailinator.com","primary":false}},"GetRecipientEmail":{"title":"GetRecipientEmail","required":["email","primary","invalid"],"type":"object","properties":{"email":{"type":"string"},"primary":{"type":"boolean"},"invalid":{"type":"boolean"}},"example":{"email":"payee-123456@mailpoof.com","primary":true,"invalid":false}},"VerifyRecipientTINRequest":{"title":"VerifyRecipientTINRequest","required":["tin","address","legal_entity_type"],"type":"object","properties":{"tin":{"type":"string"},"address":{"$ref":"#/components/schemas/Address"},"legal_entity_type":{"type":"string"}},"example":{"tin":"123456789","address":{"address_1":"134 N 4th St","city":"Brooklyn","state":"NY","zip":"11249"},"legal_entity_type":"INDIVIDUAL"}},"Address":{"title":"Address","required":["address_1","city","state","zip"],"type":"object","properties":{"address_1":{"type":"string"},"city":{"type":"string"},"state":{"type":"string"},"zip":{"type":"string"}},"example":{"address_1":"134 N 4th St","city":"Brooklyn","state":"NY","zip":"11249"}},"CreateCardAccountRequest":{"title":"CreateCardAccountRequest","required":["card_number","exp_date"],"type":"object","properties":{"card_number":{"type":"string"},"exp_date":{"type":"string"}},"example":{"card_number":"4515300011000001","exp_date":"2030-01"}},"CreateCardAccountFailure-CreditRequest":{"title":"CreateCardAccountFailure-CreditRequest","required":["card_number","exp_date"],"type":"object","properties":{"card_number":{"type":"string"},"exp_date":{"type":"string"}},"example":{"card_number":"4500600000000061","exp_date":"2030-01"}},"CreateCardAccountFailure-InvalidRequest":{"title":"CreateCardAccountFailure-InvalidRequest","required":["card_number","exp_date"],"type":"object","properties":{"card_number":{"type":"string"},"exp_date":{"type":"string"}},"example":{"card_number":"4444440000000000","exp_date":"2030-01"}},"CreateBankAccountRequest":{"title":"CreateBankAccountRequest","required":["account_number","routing_number","account_type"],"type":"object","properties":{"account_number":{"type":"string"},"routing_number":{"type":"string"},"account_type":{"type":"string"}},"example":{"account_number":"123456789","routing_number":"051504597","account_type":"CHECKING"}},"CreatePayPalAccountRequest":{"title":"CreatePayPalAccountRequest","required":["email"],"type":"object","properties":{"email":{"type":"string"}},"example":{"email":"email@domain.com"}},"CreatePaymentRequest":{"title":"CreatePaymentRequest","required":["recipient_id","amount"],"type":"object","properties":{"recipient_id":{"type":"string"},"amount":{"type":"number"}},"example":{"recipient_id":"{{recipient_id}}","amount":25}},"CreatePaymentwithEmailRequest":{"title":"CreatePaymentwithEmailRequest","required":["recipient_email","amount"],"type":"object","properties":{"recipient_email":{"type":"string"},"amount":{"type":"number"}},"example":{"recipient_email":"{{recipient_email}}","amount":25}},"UpdatePaymentRequest":{"title":"UpdatePaymentRequest","required":["status"],"type":"object","properties":{"status":{"type":"string"}},"example":{"status":"CANCELLED"}},"CreateTransactionRequest":{"title":"CreateTransactionRequest","required":["recipient_id","account_id","method","type","amount"],"type":"object","properties":{"recipient_id":{"type":"string"},"account_id":{"type":"string"},"method":{"type":"string"},"type":{"type":"string"},"amount":{"type":"integer","format":"int32"}},"example":{"recipient_id":"{{recipient_id}}","account_id":"{{account_id}}","method":"ACH_SAME_DAY","type":"CREDIT","amount":10}}},"securitySchemes":{"httpBearer":{"type":"http","scheme":"bearer"}}},"security":[{"httpBearer":[]}],"tags":[{"name":"Authentication","description":"OAuth 2.0 is used for authentication and authorization to the API. Client ID and Secret Key can be generated in the Developer Portal."},{"name":"Payers","description":"Endpoints to retrieve a payer's connected accounts (aka good funds accounts) and payout method configuration for the `payer_id` designated in the URL."},{"name":"Recipients"},{"name":"Recipient Emails"},{"name":"Recipient Verification"},{"name":"Payment Accounts - Card"},{"name":"Payment Accounts - Bank"},{"name":"Payment Accounts - PayPal"},{"name":"Payments"},{"name":"Transactions"}]}